Last updated: 04-04-2024
Download OpenAPI specification:Download
The Nutanix REST APIs allow you to create scripts that run system administration commands against the Nutanix cluster. The API enables the use of HTTP requests to get information about the cluster as well as make changes to the configuration. Output from the API calls are returned in JSON format.
All API users should have valid Prism login credentials to send API calls to the Prism server. APIs on nutanix.dev portal are publicly available to all valid users without special permissions for viewing purposes.
The v2 API is an update of the v1 API. Users of the v1 API are encouraged to migrate to v2.
Nutanix API versions – What are they and what does each one do?
Acknowledge Alert with the specified Id.
id required | string Alert Id |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/{id}/acknowledge \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "id": "string",
- "message": "string",
- "successful": true
}
Acknowledge alerts using a filter criteria.
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
severity | string Severity |
impact_types | string Impact Type of alerts |
classifications | string Classification of alerts |
entity_type | string Entity Type |
entity_type_ids | string Entity Type Ids |
count | integer <int32> Maximum number of alerts |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/acknowledge \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "alert_status_list": [
- {
- "id": "string",
- "message": "string",
- "successful": true
}
], - "num_failed_updates": 0,
- "num_successful_updates": 0
}
Create a new User Defined Alert Policy.
New User Defined Alert Policy
auto_resolve | boolean |
created_by | string |
description | string |
enabled | boolean |
error_on_conflict | boolean |
filter | string |
id | string |
impact_types | Array of strings |
last_updated_timestamp_in_usecs | integer <int64> |
policies_to_override | Array of strings |
Array of objects (create.dto.alerts.AlertPolicyDTO_RelatedPolicies) | |
title | string |
Array of objects (create.dto.alerts.AlertPolicyDTO_TriggerCondition) | |
trigger_wait_period_in_secs | integer <int64> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/policies \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "auto_resolve": true, "created_by": "string", "description": "string", "enabled": true, "error_on_conflict": true, "filter": "string", "id": "string", "impact_types": [ "string" ], "last_updated_timestamp_in_usecs": 0, "policies_to_override": [ "string" ], "related_policies": [ { "entity_uuid": "string", "policy_ids": [ "string" ] } ], "title": "string", "trigger_conditions": [ { "condition": "string", "condition_type": "STATIC_THRESHOLD", "severity_level": "CRITICAL" } ], "trigger_wait_period_in_secs": 0 }'
{- "auto_resolve": true,
- "created_by": "string",
- "description": "string",
- "enabled": true,
- "error_on_conflict": true,
- "filter": "string",
- "id": "string",
- "impact_types": [
- "string"
], - "last_updated_timestamp_in_usecs": 0,
- "policies_to_override": [
- "string"
], - "related_policies": [
- {
- "entity_uuid": "string",
- "policy_ids": [
- "string"
]
}
], - "title": "string",
- "trigger_conditions": [
- {
- "condition": "string",
- "condition_type": "STATIC_THRESHOLD",
- "severity_level": "CRITICAL"
}
], - "trigger_wait_period_in_secs": 0
}
Delete the specified User Defined Alert Policy
policy_id required | string Alert Policy ID |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/policies/{policy_id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Get all User Defined Alert Policies
entity_type | string Entity type |
entity_ids | string Entity ids |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/policies \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "auto_resolve": true,
- "created_by": "string",
- "description": "string",
- "enabled": true,
- "error_on_conflict": true,
- "filter": "string",
- "id": "string",
- "impact_types": [
- "string"
], - "last_updated_timestamp_in_usecs": 0,
- "policies_to_override": [
- "string"
], - "related_policies": [
- {
- "entity_uuid": "string",
- "policy_ids": [
- "string"
]
}
], - "title": "string",
- "trigger_conditions": [
- {
- "condition": "string",
- "condition_type": "STATIC_THRESHOLD",
- "severity_level": "CRITICAL"
}
], - "trigger_wait_period_in_secs": 0
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/configuration \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "default_nutanix_email": "string",
- "email_config_rules": [
- {
- "categories": [
- "string"
], - "cluster_uuids": [
- "string"
], - "impact_types": [
- "string"
], - "include_global_email_contact_list": true,
- "match_phrases": [
- "string"
], - "recipients": [
- "string"
], - "severities": [
- "string"
]
}
], - "email_contact_list": [
- "string"
], - "email_template": {
- "body_suffix": "string",
- "subject_prefix": "string"
}, - "enable": true,
- "enable_default_nutanix_email": true,
- "enable_email_digest": true,
- "skip_empty_alert_email_digest": true,
- "smtp_server": {
- "address": "string",
- "email_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "from_email_address": "string",
- "password": "string",
- "port": 0,
- "secure_mode": "STARTTLS",
- "server_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "username": "string"
}, - "tunnel_details": {
- "connection_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "http_proxy": {
- "address": "string",
- "address_value": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "name": "string",
- "password": "string",
- "port": 65536,
- "proxy_types": [
- "HTTP"
], - "username": "string"
}, - "service_center": {
- "ip_address": "string",
- "name": "string",
- "port": 65536,
- "username": "string"
}, - "transport_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}
}
}
Get the list of Alerts generated in the cluster.
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
auto_resolved | boolean Alerts which have been auto resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
entity_type | string Entity type |
entity_ids | string Entity ids |
impact_types | string Impact Types |
classification | string Classification |
alert_ids | string Alert ids |
get_causes | boolean Get causes |
detailed_info | boolean Get detailed info |
clusterUuid | string |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'clusterUuid: string' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the User Defined Alert Policy
policy_id required | string Alert Policy ID |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/policies/{policy_id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "auto_resolve": true,
- "created_by": "string",
- "description": "string",
- "enabled": true,
- "error_on_conflict": true,
- "filter": "string",
- "id": "string",
- "impact_types": [
- "string"
], - "last_updated_timestamp_in_usecs": 0,
- "policies_to_override": [
- "string"
], - "related_policies": [
- {
- "entity_uuid": "string",
- "policy_ids": [
- "string"
]
}
], - "title": "string",
- "trigger_conditions": [
- {
- "condition": "string",
- "condition_type": "STATIC_THRESHOLD",
- "severity_level": "CRITICAL"
}
], - "trigger_wait_period_in_secs": 0
}
Modify the configuration that is used to send Alert emails.
new Alert configuration.
cluster_uuid | string |
object (patch.dto.appliance.configuration.AlertConfigDTO) DTO representing the configuration of alerts | |
operation | string |
curl --request PATCH \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/configuration \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid": "string", "generic_dto": { "default_nutanix_email": "string", "email_config_rules": [ { "categories": [ "string" ], "cluster_uuids": [ "string" ], "impact_types": [ "string" ], "include_global_email_contact_list": true, "match_phrases": [ "string" ], "recipients": [ "string" ], "severities": [ "string" ] } ], "email_contact_list": [ "string" ], "email_template": { "body_suffix": "string", "subject_prefix": "string" }, "enable": true, "enable_default_nutanix_email": true, "enable_email_digest": true, "skip_empty_alert_email_digest": true, "smtp_server": { "address": "string", "email_status": { "last_changed_time_stamp_usecs": 0, "last_checked_time_stamp_usecs": 0, "last_successful_transmission_time_stamp_usecs": 0, "message": { "attributes": { "property1": "string", "property2": "string" }, "message": "string" }, "status": "SUCCESS" }, "from_email_address": "string", "password": "string", "port": 0, "secure_mode": "STARTTLS", "server_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "username": "string" }, "tunnel_details": { "connection_status": { "last_changed_time_stamp_usecs": 0, "last_checked_time_stamp_usecs": 0, "last_successful_transmission_time_stamp_usecs": 0, "message": { "attributes": { "property1": "string", "property2": "string" }, "message": "string" }, "status": "SUCCESS" }, "http_proxy": { "address": "string", "address_value": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "name": "string", "password": "string", "port": 0, "proxy_types": [ "string" ], "username": "string" }, "service_center": { "ip_address": "string", "name": "string", "port": 0, "username": "string" }, "transport_status": { "last_changed_time_stamp_usecs": 0, "last_checked_time_stamp_usecs": 0, "last_successful_transmission_time_stamp_usecs": 0, "message": { "attributes": { "property1": "string", "property2": "string" }, "message": "string" }, "status": "SUCCESS" } } }, "operation": "string" }'
{- "default_nutanix_email": "string",
- "email_config_rules": [
- {
- "categories": [
- "string"
], - "cluster_uuids": [
- "string"
], - "impact_types": [
- "string"
], - "include_global_email_contact_list": true,
- "match_phrases": [
- "string"
], - "recipients": [
- "string"
], - "severities": [
- "string"
]
}
], - "email_contact_list": [
- "string"
], - "email_template": {
- "body_suffix": "string",
- "subject_prefix": "string"
}, - "enable": true,
- "enable_default_nutanix_email": true,
- "enable_email_digest": true,
- "skip_empty_alert_email_digest": true,
- "smtp_server": {
- "address": "string",
- "email_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "from_email_address": "string",
- "password": "string",
- "port": 0,
- "secure_mode": "STARTTLS",
- "server_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "username": "string"
}, - "tunnel_details": {
- "connection_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "http_proxy": {
- "address": "string",
- "address_value": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "name": "string",
- "password": "string",
- "port": 65536,
- "proxy_types": [
- "HTTP"
], - "username": "string"
}, - "service_center": {
- "ip_address": "string",
- "name": "string",
- "port": 65536,
- "username": "string"
}, - "transport_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}
}
}
auto_resolve | boolean |
created_by | string |
description | string |
enabled | boolean |
error_on_conflict | boolean |
filter | string |
id | string |
impact_types | Array of strings |
last_updated_timestamp_in_usecs | integer <int64> |
policies_to_override | Array of strings |
Array of objects (create.dto.alerts.AlertPolicyDTO_RelatedPolicies) | |
title | string |
Array of objects (create.dto.alerts.AlertPolicyDTO_TriggerCondition) | |
trigger_wait_period_in_secs | integer <int64> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/policies/conflicting_policies \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "auto_resolve": true, "created_by": "string", "description": "string", "enabled": true, "error_on_conflict": true, "filter": "string", "id": "string", "impact_types": [ "string" ], "last_updated_timestamp_in_usecs": 0, "policies_to_override": [ "string" ], "related_policies": [ { "entity_uuid": "string", "policy_ids": [ "string" ] } ], "title": "string", "trigger_conditions": [ { "condition": "string", "condition_type": "STATIC_THRESHOLD", "severity_level": "CRITICAL" } ], "trigger_wait_period_in_secs": 0 }'
{- "entities": [
- {
- "auto_resolve": true,
- "created_by": "string",
- "description": "string",
- "enabled": true,
- "error_on_conflict": true,
- "filter": "string",
- "id": "string",
- "impact_types": [
- "string"
], - "last_updated_timestamp_in_usecs": 0,
- "policies_to_override": [
- "string"
], - "related_policies": [
- {
- "entity_uuid": "string",
- "policy_ids": [
- "string"
]
}
], - "title": "string",
- "trigger_conditions": [
- {
- "condition": "string",
- "condition_type": "STATIC_THRESHOLD",
- "severity_level": "CRITICAL"
}
], - "trigger_wait_period_in_secs": 0
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Resolve Alert with the specified Id.
id required | string Alert Id |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/{id}/resolve \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "id": "string",
- "message": "string",
- "successful": true
}
Resolve alerts using a filter criteria.
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
severity | string Severity |
impact_types | string Impact Type of alerts |
classifications | string Classifications of alerts |
entity_type | string Entity Type |
entity_type_ids | string Entity Type Ids |
count | integer <int32> Maximum number of alerts |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/resolve \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "alert_status_list": [
- {
- "id": "string",
- "message": "string",
- "successful": true
}
], - "num_failed_updates": 0,
- "num_successful_updates": 0
}
Update a User Defined Alert Policy.
Alert Policy with updated configurations
auto_resolve | boolean |
created_by | string |
description | string |
enabled | boolean |
error_on_conflict | boolean |
filter | string |
id | string |
impact_types | Array of strings |
last_updated_timestamp_in_usecs | integer <int64> |
policies_to_override | Array of strings |
Array of objects (update.dto.alerts.AlertPolicyDTO_RelatedPolicies) | |
title | string |
Array of objects (update.dto.alerts.AlertPolicyDTO_TriggerCondition) | |
trigger_wait_period_in_secs | integer <int64> |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/policies \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "auto_resolve": true, "created_by": "string", "description": "string", "enabled": true, "error_on_conflict": true, "filter": "string", "id": "string", "impact_types": [ "string" ], "last_updated_timestamp_in_usecs": 0, "policies_to_override": [ "string" ], "related_policies": [ { "entity_uuid": "string", "policy_ids": [ "string" ] } ], "title": "string", "trigger_conditions": [ { "condition": "string", "condition_type": "STATIC_THRESHOLD", "severity_level": "CRITICAL" } ], "trigger_wait_period_in_secs": 0 }'
{- "auto_resolve": true,
- "created_by": "string",
- "description": "string",
- "enabled": true,
- "error_on_conflict": true,
- "filter": "string",
- "id": "string",
- "impact_types": [
- "string"
], - "last_updated_timestamp_in_usecs": 0,
- "policies_to_override": [
- "string"
], - "related_policies": [
- {
- "entity_uuid": "string",
- "policy_ids": [
- "string"
]
}
], - "title": "string",
- "trigger_conditions": [
- {
- "condition": "string",
- "condition_type": "STATIC_THRESHOLD",
- "severity_level": "CRITICAL"
}
], - "trigger_wait_period_in_secs": 0
}
Update the configuration that is used to send Alert emails.
new Alert configuration.
default_nutanix_email | string |
Array of objects (update.dto.appliance.configuration.AlertConfigDTO_EmailConfigurationRule) | |
email_contact_list | Array of strings |
object (update.dto.appliance.configuration.AlertConfigDTO_EmailTemplate) | |
enable | boolean |
enable_default_nutanix_email | boolean |
enable_email_digest | boolean |
skip_empty_alert_email_digest | boolean |
object (update.dto.appliance.configuration.SmtpServerDTO) | |
object (update.dto.appliance.configuration.RemoteTunnelDetailsDTO) |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/alerts/configuration \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "default_nutanix_email": "string", "email_config_rules": [ { "categories": [ "string" ], "cluster_uuids": [ "string" ], "impact_types": [ "string" ], "include_global_email_contact_list": true, "match_phrases": [ "string" ], "recipients": [ "string" ], "severities": [ "string" ] } ], "email_contact_list": [ "string" ], "email_template": { "body_suffix": "string", "subject_prefix": "string" }, "enable": true, "enable_default_nutanix_email": true, "enable_email_digest": true, "skip_empty_alert_email_digest": true, "smtp_server": { "address": "string", "email_status": { "last_changed_time_stamp_usecs": 0, "last_checked_time_stamp_usecs": 0, "last_successful_transmission_time_stamp_usecs": 0, "message": { "attributes": { "property1": "string", "property2": "string" }, "message": "string" }, "status": "SUCCESS" }, "from_email_address": "string", "password": "string", "port": 0, "secure_mode": "STARTTLS", "server_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "username": "string" }, "tunnel_details": { "connection_status": { "last_changed_time_stamp_usecs": 0, "last_checked_time_stamp_usecs": 0, "last_successful_transmission_time_stamp_usecs": 0, "message": { "attributes": { "property1": "string", "property2": "string" }, "message": "string" }, "status": "SUCCESS" }, "http_proxy": { "address": "string", "address_value": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "name": "string", "password": "string", "port": 0, "proxy_types": [ "string" ], "username": "string" }, "service_center": { "ip_address": "string", "name": "string", "port": 0, "username": "string" }, "transport_status": { "last_changed_time_stamp_usecs": 0, "last_checked_time_stamp_usecs": 0, "last_successful_transmission_time_stamp_usecs": 0, "message": { "attributes": { "property1": "string", "property2": "string" }, "message": "string" }, "status": "SUCCESS" } } }'
{- "default_nutanix_email": "string",
- "email_config_rules": [
- {
- "categories": [
- "string"
], - "cluster_uuids": [
- "string"
], - "impact_types": [
- "string"
], - "include_global_email_contact_list": true,
- "match_phrases": [
- "string"
], - "recipients": [
- "string"
], - "severities": [
- "string"
]
}
], - "email_contact_list": [
- "string"
], - "email_template": {
- "body_suffix": "string",
- "subject_prefix": "string"
}, - "enable": true,
- "enable_default_nutanix_email": true,
- "enable_email_digest": true,
- "skip_empty_alert_email_digest": true,
- "smtp_server": {
- "address": "string",
- "email_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "from_email_address": "string",
- "password": "string",
- "port": 0,
- "secure_mode": "STARTTLS",
- "server_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "username": "string"
}, - "tunnel_details": {
- "connection_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "http_proxy": {
- "address": "string",
- "address_value": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "name": "string",
- "password": "string",
- "port": 65536,
- "proxy_types": [
- "HTTP"
], - "username": "string"
}, - "service_center": {
- "ip_address": "string",
- "name": "string",
- "port": 65536,
- "username": "string"
}, - "transport_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}
}
}
Add Auth types to the existing Auth types.
List of Auth types
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/add_auth_types \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- "LOCAL"
]
Add Directory config to the cluster.
A Directory instance
connection_type | string Value: "LDAP" |
directory_type | string Enum: "ACTIVE_DIRECTORY" "OPEN_LDAP" |
directory_url | string |
domain | string |
group_search_type | string Enum: "RECURSIVE" "NON_RECURSIVE" |
name | string |
object (create.auth.dto.config.OpenLdapConfigDTO) Open LDAP configuration | |
service_account_password | string |
service_account_username | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/directories \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "connection_type": "LDAP", "directory_type": "ACTIVE_DIRECTORY", "directory_url": "string", "domain": "string", "group_search_type": "RECURSIVE", "name": "string", "open_ldap_config": { "group_member_attribute": "string", "group_member_attribute_value": "string", "group_object_class": "string", "group_search_base": "string", "user_object_class": "string", "user_search_base": "string", "username_attribute": "string" }, "service_account_password": "string", "service_account_username": "string" }'
{- "connection_type": "LDAP",
- "directory_type": "ACTIVE_DIRECTORY",
- "directory_url": "string",
- "domain": "string",
- "group_search_type": "RECURSIVE",
- "name": "string",
- "open_ldap_config": {
- "group_member_attribute": "string",
- "group_member_attribute_value": "string",
- "group_object_class": "string",
- "group_search_base": "string",
- "user_object_class": "string",
- "user_search_base": "string",
- "username_attribute": "string"
}, - "service_account_password": "string",
- "service_account_username": "string"
}
Delete Auth configuration from the cluster. This will also delete all the directories configured in the cluster.
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Delete client chain certificate on the cluster.
name required | string Name of the Certificate |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/client_auth/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: multipart/form-data' \
{- "value": true
}
Delete Directory config with the specified name.
name required | string Name of the Directory |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/directories/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Edit the specified Directory config.
A Directory instance
connection_type | string Value: "LDAP" |
directory_type | string Enum: "ACTIVE_DIRECTORY" "OPEN_LDAP" |
directory_url | string |
domain | string |
group_search_type | string Enum: "RECURSIVE" "NON_RECURSIVE" |
name | string |
object (update.auth.dto.config.OpenLdapConfigDTO) Open LDAP configuration | |
service_account_password | string |
service_account_username | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/directories \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "connection_type": "LDAP", "directory_type": "ACTIVE_DIRECTORY", "directory_url": "string", "domain": "string", "group_search_type": "RECURSIVE", "name": "string", "open_ldap_config": { "group_member_attribute": "string", "group_member_attribute_value": "string", "group_object_class": "string", "group_search_base": "string", "user_object_class": "string", "user_search_base": "string", "username_attribute": "string" }, "service_account_password": "string", "service_account_username": "string" }'
{- "connection_type": "LDAP",
- "directory_type": "ACTIVE_DIRECTORY",
- "directory_url": "string",
- "domain": "string",
- "group_search_type": "RECURSIVE",
- "name": "string",
- "open_ldap_config": {
- "group_member_attribute": "string",
- "group_member_attribute_value": "string",
- "group_object_class": "string",
- "group_search_base": "string",
- "user_object_class": "string",
- "user_search_base": "string",
- "username_attribute": "string"
}, - "service_account_password": "string",
- "service_account_username": "string"
}
Enable/disable client authentication on the cluster.
Enable client auth
value | boolean |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/client_auth \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": true }'
{- "ca_chain": [
- "string"
], - "enable_client_auth": true,
- "name": "string"
}
Get the complete Auth configuration including directories configured in the cluster.
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "auth_type_list": [
- "LOCAL"
], - "directory_list": [
- {
- "connection_type": "LDAP",
- "directory_type": "ACTIVE_DIRECTORY",
- "directory_url": "string",
- "domain": "string",
- "group_search_type": "RECURSIVE",
- "name": "string",
- "open_ldap_config": {
- "group_member_attribute": "string",
- "group_member_attribute_value": "string",
- "group_object_class": "string",
- "group_search_base": "string",
- "user_object_class": "string",
- "user_search_base": "string",
- "username_attribute": "string"
}, - "service_account_password": "string",
- "service_account_username": "string"
}
]
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/auth_types \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- "LOCAL"
]
Get the client authentication status configured on the cluster.
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/client_auth \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "auto_login_info": {
- "enabled": true,
- "service_account_dto": {
- "directory_config_name": "string",
- "password": "string",
- "username": "string"
}
}, - "ca_chain_info": {
- "ca_chain": [
- "string"
], - "enable_client_auth": true,
- "name": "string"
}, - "cert_revocation_info": {
- "crl_distribution_points": [
- "string"
], - "global_crl_refresh_interval": 0,
- "ocsp_responder": "string"
}
}
Get Directory with the specified name.
name required | string Name of the Directory |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/directories/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "connection_type": "LDAP",
- "directory_type": "ACTIVE_DIRECTORY",
- "directory_url": "string",
- "domain": "string",
- "group_search_type": "RECURSIVE",
- "name": "string",
- "open_ldap_config": {
- "group_member_attribute": "string",
- "group_member_attribute_value": "string",
- "group_object_class": "string",
- "group_search_base": "string",
- "user_object_class": "string",
- "user_search_base": "string",
- "username_attribute": "string"
}, - "service_account_password": "string",
- "service_account_username": "string"
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/directories \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "connection_type": "LDAP",
- "directory_type": "ACTIVE_DIRECTORY",
- "directory_url": "string",
- "domain": "string",
- "group_search_type": "RECURSIVE",
- "name": "string",
- "open_ldap_config": {
- "group_member_attribute": "string",
- "group_member_attribute_value": "string",
- "group_object_class": "string",
- "group_search_base": "string",
- "user_object_class": "string",
- "user_search_base": "string",
- "username_attribute": "string"
}, - "service_account_password": "string",
- "service_account_username": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/directory_domains \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- "string"
]
Modify the Auth configuration excluding directories configured in the cluster.
an AuthConfigDTO instance
cluster_uuid | string |
object (patch.auth.dto.config.AuthConfigDTO) auth-config | |
operation | string |
curl --request PATCH \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid": "string", "generic_dto": { "auth_type_list": [ "string" ], "directory_list": [ { "connection_type": "LDAP", "directory_type": "ACTIVE_DIRECTORY", "directory_url": "string", "domain": "string", "group_search_type": "RECURSIVE", "name": "string", "open_ldap_config": { "group_member_attribute": "string", "group_member_attribute_value": "string", "group_object_class": "string", "group_search_base": "string", "user_object_class": "string", "user_search_base": "string", "username_attribute": "string" }, "service_account_password": "string", "service_account_username": "string" } ] }, "operation": "string" }'
{- "auth_type_list": [
- "LOCAL"
], - "directory_list": [
- {
- "connection_type": "LDAP",
- "directory_type": "ACTIVE_DIRECTORY",
- "directory_url": "string",
- "domain": "string",
- "group_search_type": "RECURSIVE",
- "name": "string",
- "open_ldap_config": {
- "group_member_attribute": "string",
- "group_member_attribute_value": "string",
- "group_object_class": "string",
- "group_search_base": "string",
- "user_object_class": "string",
- "user_search_base": "string",
- "username_attribute": "string"
}, - "service_account_password": "string",
- "service_account_username": "string"
}
]
}
Modify the specified Directory config.
A Directory instance
cluster_uuid | string |
object (patch.auth.dto.config.DirectoryConfigDTO) directory-config | |
operation | string |
curl --request PATCH \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/directories \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid": "string", "generic_dto": { "connection_type": "LDAP", "directory_type": "ACTIVE_DIRECTORY", "directory_url": "string", "domain": "string", "group_search_type": "RECURSIVE", "name": "string", "open_ldap_config": { "group_member_attribute": "string", "group_member_attribute_value": "string", "group_object_class": "string", "group_search_base": "string", "user_object_class": "string", "user_search_base": "string", "username_attribute": "string" }, "service_account_password": "string", "service_account_username": "string" }, "operation": "string" }'
{- "connection_type": "LDAP",
- "directory_type": "ACTIVE_DIRECTORY",
- "directory_url": "string",
- "domain": "string",
- "group_search_type": "RECURSIVE",
- "name": "string",
- "open_ldap_config": {
- "group_member_attribute": "string",
- "group_member_attribute_value": "string",
- "group_object_class": "string",
- "group_search_base": "string",
- "user_object_class": "string",
- "user_search_base": "string",
- "username_attribute": "string"
}, - "service_account_password": "string",
- "service_account_username": "string"
}
filename required | string <binary> Name of the Certificate |
chain required | string <binary> Certificate content |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/client_auth/ca_chain \ --header 'Accept: application/json' \ --header 'Content-Type: multipart/form-data' \ --data '{ "chain": null, "filename": null }'
{- "ca_chain": [
- "string"
], - "enable_client_auth": true,
- "name": "string"
}
Remove Auth types from the existing Auth types.
List of Auth types
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/remove_auth_types \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- "LOCAL"
]
Username, active directory name and password to authenticate
directory_name | string |
password | string |
username | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/directories/connection_status \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "directory_name": "string", "password": "string", "username": "string" }'
{- "value": true
}
Update the Auth configuration excluding directories configured in the cluster.
an AuthConfigDTO instance
auth_type_list | Array of strings Items Enum: "LOCAL" "DIRECTORY_SERVICE" |
Array of objects (update.auth.dto.config.DirectoryConfigDTO) |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "auth_type_list": [ "string" ], "directory_list": [ { "connection_type": "LDAP", "directory_type": "ACTIVE_DIRECTORY", "directory_url": "string", "domain": "string", "group_search_type": "RECURSIVE", "name": "string", "open_ldap_config": { "group_member_attribute": "string", "group_member_attribute_value": "string", "group_object_class": "string", "group_search_base": "string", "user_object_class": "string", "user_search_base": "string", "username_attribute": "string" }, "service_account_password": "string", "service_account_username": "string" } ] }'
{- "auth_type_list": [
- "LOCAL"
], - "directory_list": [
- {
- "connection_type": "LDAP",
- "directory_type": "ACTIVE_DIRECTORY",
- "directory_url": "string",
- "domain": "string",
- "group_search_type": "RECURSIVE",
- "name": "string",
- "open_ldap_config": {
- "group_member_attribute": "string",
- "group_member_attribute_value": "string",
- "group_object_class": "string",
- "group_search_base": "string",
- "user_object_class": "string",
- "user_search_base": "string",
- "username_attribute": "string"
}, - "service_account_password": "string",
- "service_account_username": "string"
}
]
}
Update Auth types configured in the Auth configuration.
List of Auth types
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/auth_types \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "auth_type_list": [
- "LOCAL"
], - "directory_list": [
- {
- "connection_type": "LDAP",
- "directory_type": "ACTIVE_DIRECTORY",
- "directory_url": "string",
- "domain": "string",
- "group_search_type": "RECURSIVE",
- "name": "string",
- "open_ldap_config": {
- "group_member_attribute": "string",
- "group_member_attribute_value": "string",
- "group_object_class": "string",
- "group_search_base": "string",
- "user_object_class": "string",
- "user_search_base": "string",
- "username_attribute": "string"
}, - "service_account_password": "string",
- "service_account_username": "string"
}
]
}
Update client authentication on the cluster.
Client auth updates
object (update.auth.dto.config.AutoLoginInfoDTO) | |
object (update.auth.dto.config.CaChainDTO) | |
object (update.auth.dto.config.CertRevocationInfoDTO) |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/authconfig/client_auth \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "auto_login_info": { "enabled": true, "service_account_dto": { "directory_config_name": "string", "password": "string", "username": "string" } }, "ca_chain_info": { "ca_chain": [ "string" ], "enable_client_auth": true, "name": "string" }, "cert_revocation_info": { "crl_distribution_points": [ "string" ], "global_crl_refresh_interval": 0, "ocsp_responder": "string" } }'
{- "auto_login_info": {
- "enabled": true,
- "service_account_dto": {
- "directory_config_name": "string",
- "password": "string",
- "username": "string"
}
}, - "ca_chain_info": {
- "ca_chain": [
- "string"
], - "enable_client_auth": true,
- "name": "string"
}, - "cert_revocation_info": {
- "crl_distribution_points": [
- "string"
], - "global_crl_refresh_interval": 0,
- "ocsp_responder": "string"
}
}
Add a cloud credential for accessing cloud sites.
cloud_type required | string Cloud type |
An instance of CloudCredentialsDTO
object (create.dto.dr.AwsCredentialDTO) | |
object (create.dto.dr.AzureCredentialDTO) | |
credential_id | integer <int64> |
name | string |
use_as_default | boolean |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cloud/{cloud_type}/credentials \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "aws_credential": { "access_key": "string", "secret_key": "string" }, "azure_credential": { "secure_file_id": "string", "subscription_id": "string" }, "credential_id": 0, "name": "string", "use_as_default": true }'
{- "aws_credential": {
- "access_key": "string",
- "secret_key": "string"
}, - "azure_credential": {
- "secure_file_id": "string",
- "subscription_id": "string"
}, - "credential_id": 0,
- "name": "string",
- "use_as_default": true
}
Deploy a cloud CVM and create a remote site.
cloud_type required | string Cloud type |
An instance of DeployCloudRemoteSiteRequestDTO
admin_password | string |
object (create.dto.dr.BandwidthPolicyDTO) This DTO describes bandwidth throttling policies for different time schedules | |
bandwidth_policy_enabled | boolean |
cerebro_ssh_port_lower_bound | integer <int32> |
cerebro_ssh_port_upper_bound | integer <int32> |
compression_enabled | boolean |
connectivity_type | string Enum: "VPN" "SSH_TUNNEL" |
credential_name | string |
image_id | string |
image_name | string |
instance_name | string |
instance_type | string |
local_container_names | Array of strings |
local_remote_site_name | string |
local_storage_container_names | Array of strings |
max_bps | integer <int32> |
proxy_enabled | boolean |
region | string |
remote_container_names | Array of strings |
remote_storage_container_names | Array of strings |
remote_storage_pool_name | string |
skip_instance_type_validation | boolean |
snap_shot_id | string |
ssh_tunnel_port | integer <int32> |
subnet_id | string |
vpc_id | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cloud/{cloud_type}/deploy_remote_site \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "admin_password": "string", "bandwidth_policy": { "bandwidth_configurations": [ { "bandwidth_limit": 0, "days_selected": 0, "end_time": 0, "schedule_uuid": "string", "start_time": 0 } ], "default_bandwidth_limit": 0, "policy_name": "string", "policy_uuid": "string" }, "bandwidth_policy_enabled": true, "cerebro_ssh_port_lower_bound": 0, "cerebro_ssh_port_upper_bound": 0, "compression_enabled": true, "connectivity_type": "VPN", "credential_name": "string", "image_id": "string", "image_name": "string", "instance_name": "string", "instance_type": "string", "local_container_names": [ "string" ], "local_remote_site_name": "string", "local_storage_container_names": [ "string" ], "max_bps": 0, "proxy_enabled": true, "region": "string", "remote_container_names": [ "string" ], "remote_storage_container_names": [ "string" ], "remote_storage_pool_name": "string", "skip_instance_type_validation": true, "snap_shot_id": "string", "ssh_tunnel_port": 0, "subnet_id": "string", "vpc_id": "string" }'
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
Get a list of CVM images that can be installed.
cloud_type required | string Cloud type |
credential_name | string Name of the credential |
region | string Region of the cvm image |
count | integer <int32> Maximum number of cloud images to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
list_local_only | boolean Is list local, to be specified only for Azure cloud type |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cloud/{cloud_type}/images \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "description": "string",
- "id": "string",
- "name": "string",
- "region": "string",
- "version": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get a list of CVMs that installed.
cloud_type required | string Cloud type |
region required | string Region |
credential_name | string Name of the credential |
count | integer <int32> Maximum number of cloud cvms to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cloud/{cloud_type}/cvms \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "name": "string",
- "private_ip": "string",
- "public_ip": "string",
- "region": "string",
- "state": "STARTING",
- "subnet_id": "string",
- "type": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get a list of subnets.
cloud_type required | string Cloud type |
region required | string Region |
credential_name | string Name of the credential |
count | integer <int32> Maximum number of subnets to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cloud/{cloud_type}/subnets \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "availability_zone": "string",
- "available_ip_count": 0,
- "default_avail_zone": true,
- "id": "string",
- "subnet_cidr": "string",
- "subnet_id": "string",
- "vpc_id": "string",
- "vpn_state": "AVAILABLE"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get cloud credentials for accessing cloud sites.
cloud_type required | string Cloud type |
count | integer <int32> Maximum number of cloud credentials to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cloud/{cloud_type}/credentials \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "aws_credential": {
- "access_key": "string",
- "secret_key": "string"
}, - "azure_credential": {
- "secure_file_id": "string",
- "subscription_id": "string"
}, - "credential_id": 0,
- "name": "string",
- "use_as_default": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
cloud_type required | string Cloud type |
credential_name required | string Name of the credential |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cloud/{cloud_type}/regions \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "region_code": "string",
- "region_name": "string",
- "type": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
certificate required | string <binary> Certificate content |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cloud/azure/upload_certificate \ --header 'Accept: application/json' \ --header 'Content-Type: multipart/form-data' \ --data '{ "certificate": null }'
{- "value": "string"
}
Remove a cloud credential for accessing cloud sites.
cloud_type required | string Cloud type |
name required | string Name of the credential |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cloud/{cloud_type}/credentials/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Remove all cloud credentials for accessing cloud sites.
cloud_type required | string Cloud type |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cloud/{cloud_type}/credentials \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Set a default cloud credential for accessing cloud sites.
cloud_type required | string Cloud type |
Name of the credential
value | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cloud/{cloud_type}/defaultcredentials \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": "string" }'
{- "aws_credential": {
- "access_key": "string",
- "secret_key": "string"
}, - "azure_credential": {
- "secure_file_id": "string",
- "subscription_id": "string"
}, - "credential_id": 0,
- "name": "string",
- "use_as_default": true
}
Add a Public Key to the cluster.
A Public Key instance
key | string |
name | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/public_keys \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "key": "string", "name": "string" }'
{- "key": "string",
- "name": "string"
}
Add the server to the name servers configured on the cluster.
Name of a name server
object (create.common.Address) |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/name_servers \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } }'
{- "value": true
}
Add the address to the NFS subnet whitelist.
NFS Whilelist
object (create.common.Address) |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/nfs_whitelist \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } }'
{- "value": true
}
Add the server to the NTP servers configured on the cluster.
Name of NTP server
object (create.common.Address) |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/ntp_servers \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } }'
{- "value": true
}
Add witness VM details.
test_only | boolean Witness VM details |
Witness VM details
Array of objects (create.common.Address) | |
cluster_name | string |
cluster_timestamp_usecs | integer <int64> |
cluster_uuid | string |
ip_addresses | Array of strings |
marked_for_removal | boolean |
nos_full_version | string |
nos_version | string |
password | string |
username | string |
uuid | string |
witness_name | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/metro_witness \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "address_list": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "cluster_name": "string", "cluster_timestamp_usecs": 0, "cluster_uuid": "string", "ip_addresses": [ "string" ], "marked_for_removal": true, "nos_full_version": "string", "nos_version": "string", "password": "string", "username": "string", "uuid": "string", "witness_name": "string" }'
{- "address_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "cluster_name": "string",
- "cluster_timestamp_usecs": 0,
- "cluster_uuid": "string",
- "ip_addresses": [
- "string"
], - "marked_for_removal": true,
- "nos_full_version": "string",
- "nos_version": "string",
- "password": "string",
- "username": "string",
- "uuid": "string",
- "witness_name": "string"
}
Delete a Metro Availability Witness
uuid required | string MA Witness uuid |
recover | boolean recover from an unsuccessful delete operation |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/metro_witness/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Delete a Public Key with the specified name.
name required | string Name of the Public Key |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/public_keys/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Delete an NTP server with the specified name.
ntp_server required | string Name of NTP server |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/ntp_servers/{ntp_server} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Delete an address from the NFS subnet whitelist.
name required | string NFS Whitelist |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/nfs_whitelist/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/smtp \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Delete a Name Server with the specified name.
nameServer required | string Name of a name server |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/name_servers/{nameServer} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Delete a Rackable Unit with the specified id.
uuid required | string Uuid of a Rackable Unit |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/rackable_units/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Get a Public Key with the specified name.
name required | string Name of the Public Key |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/public_keys/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "key": "string",
- "name": "string"
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "all_hyperv_nodes_in_failover_cluster": true,
- "block_serials": [
- "string"
], - "cloudcluster": true,
- "cluster_arch": "string",
- "cluster_data_state": {
- "cluster_available": true,
- "cluster_data_available": true,
- "cluster_register_time_usecs": 0,
- "cluster_uuid": "string",
- "first_unavailable_time_usecs": 0,
- "last_alerts_data_transferred_usecs": 0,
- "last_arithmos_data_transferred_usecs": 0
}, - "cluster_external_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_external_ipaddress": "string",
- "cluster_fully_qualified_domain_name": "string",
- "cluster_functions": [
- "NDFS"
], - "cluster_gpus": [
- "string"
], - "cluster_incarnation_id": 0,
- "cluster_masquerading_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_masquerading_ipaddress": "string",
- "cluster_masquerading_port": 0,
- "cluster_redundancy_state": {
- "current_redundancy_factor": 0,
- "desired_redundancy_factor": 0,
- "redundancy_status": {
- "property1": true,
- "property2": true
}
}, - "cluster_resiliency_preference": {
- "current_resiliency_preference": "DELAYED",
- "desired_resiliency_preference": "DELAYED"
}, - "cluster_usage_critical_alert_threshold_pct": 0,
- "cluster_usage_warning_alert_threshold_pct": 0,
- "cluster_uuid": "string",
- "common_criteria_mode": true,
- "credential": {
- "logon_name": "string",
- "password": "string"
}, - "data_in_transit_encryption_dto": {
- "enabled": true,
- "last_disabled_timestamp_secs": 0,
- "last_enabled_timestamp_secs": 0
}, - "disable_degraded_node_monitoring": true,
- "domain": "string",
- "enable_efficient_metric_sync": true,
- "enable_lock_down": true,
- "enable_on_disk_dedup": true,
- "enable_password_remote_login_to_cluster": true,
- "enable_rebuild_reservation": true,
- "enable_rf1_container": true,
- "enable_shadow_clones": true,
- "encrypted": true,
- "enforce_rackable_unit_aware_placement": true,
- "external_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "external_subnet": "string",
- "fault_tolerance_domain_type": "RACK",
- "fingerprint_content_cache_percentage": 0,
- "full_version": "string",
- "global_nfs_white_list": [
- "string"
], - "global_nfs_white_list_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "gpu_driver_version": "string",
- "has_self_encrypting_drive": true,
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "http_proxies": [
- {
- "address": "string",
- "address_value": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "name": "string",
- "password": "string",
- "port": 65536,
- "proxy_types": [
- "HTTP"
], - "username": "string"
}
], - "hypervisor_lldp_config": { },
- "hypervisor_security_compliance_config": { },
- "hypervisor_types": [
- "kVMware"
], - "id": "string",
- "internal_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "internal_subnet": "string",
- "is_lts": true,
- "is_nsenabled": true,
- "is_registered_to_pc": true,
- "is_ssp_enabled": true,
- "is_upgrade_in_progress": true,
- "iscsi_config": {
- "external_client_enabled": true
}, - "management_servers": [
- {
- "drs_enabled": true,
- "drs_vm_behaviour": "UNKNOWN",
- "ha_enabled": true,
- "in_use": true,
- "ip_address": "string",
- "management_server_type": "VCENTER",
- "registered": true
}
], - "multicluster": true,
- "name": "string",
- "name_servers": [
- "string"
], - "name_servers_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "ncc_version": "string",
- "nos_cluster_and_hosts_domain_joined": true,
- "ntp_servers": [
- "string"
], - "ntp_servers_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "num_nodes": 0,
- "operation_mode": "NORMAL",
- "public_keys": [
- {
- "key": "string",
- "name": "string"
}
], - "rackable_units": [
- {
- "id": 0,
- "location": "string",
- "model": "string",
- "model_name": "string",
- "node_uuids": [
- "string"
], - "nodes": [
- 0
], - "positions": [
- "string"
], - "rackable_unit_uuid": "string",
- "serial": "string"
}
], - "recycle_bin_dto": {
- "delete_intent_set": true,
- "recycle_bin_disabled_reason": "SPACE_THRESHOLD_EXCEEDED",
- "recycle_bin_disabled_timestamp_secs": 0,
- "recycle_bin_ttlsecs": 604800
}, - "security_compliance_config": {
- "enable_snmpv3_only": true
}, - "segmented_iscsi_data_services_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "segmented_iscsi_data_services_ipaddress": "string",
- "service_centers": [
- {
- "ip_address": "string",
- "name": "string",
- "port": 65536,
- "username": "string"
}
], - "smtp_server": {
- "address": "string",
- "email_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "from_email_address": "string",
- "password": "string",
- "port": 0,
- "secure_mode": "STARTTLS",
- "server_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "username": "string"
}, - "ssd_pinning_percentage_limit": 0,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "storage_type": "ALL_FLASH",
- "support_verbosity_type": "NOTHING",
- "target_version": "string",
- "threshold_for_storage_thin_provision": 0.1,
- "timezone": "string",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "version": "string"
}
Get domain fault tolerance status of the cluster for the specified domain
domainType required | string Type of tolerance domain |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/domain_fault_tolerance_status/{domainType} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "cluster_non_fault_tolerant_entries": 0,
- "cluster_under_replicated_data_bytes": 0,
- "component_fault_tolerance_status": {
- "property1": {
- "component_type": "EXTENT_GROUPS",
- "details": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "last_updated_time_in_usecs": 0,
- "number_of_failures_tolerable": 0,
- "under_computation": true
}, - "property2": {
- "component_type": "EXTENT_GROUPS",
- "details": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "last_updated_time_in_usecs": 0,
- "number_of_failures_tolerable": 0,
- "under_computation": true
}
}, - "domain_type": "RACK"
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/nfs_whitelist \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- { }
]
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/remote_support \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "enable": {
- "duration": 0,
- "enabled": true
}, - "tunnel_details": {
- "connection_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "http_proxy": {
- "address": "string",
- "address_value": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "name": "string",
- "password": "string",
- "port": 65536,
- "proxy_types": [
- "HTTP"
], - "username": "string"
}, - "service_center": {
- "ip_address": "string",
- "name": "string",
- "port": 65536,
- "username": "string"
}, - "transport_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}
}
}
Perform a spotlight search on the cluster.
search_string required | string Search string |
entity_types | Array of strings Entity types |
field_names | Array of strings Field Names |
maxCount | integer <int32> Maximum entities to retrieve, the default value is 100 |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/search \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "cluster_name": "string",
- "cluster_uuid": "string",
- "entity_id": "string",
- "entity_name": "string",
- "entity_type": "string",
- "entity_uuid": "string",
- "field_name": "string",
- "field_value": "string"
}
]
Get the stats for the specified metrics. If start time and end time are included in the query string, then historical stats are retrieved. Otherwise, the latest statsare retrieved.
metrics required | Array of strings List of metrics |
start_time_in_usecs required | integer <int64> Start time in microseconds |
end_time_in_usecs required | integer <int64> End time in microseconds |
interval_in_secs required | integer <int32> Sampling interval of stats |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/stats \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "stats_specific_responses": [
- {
- "interval_in_secs": 0,
- "message": "string",
- "metric": "string",
- "start_time_in_usecs": 0,
- "successful": true,
- "values": [
- 0
]
}
]
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/name_servers \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- { }
]
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/ntp_servers \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- { }
]
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/public_keys \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "key": "string",
- "name": "string"
}
]
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/rackable_units \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "id": 0,
- "location": "string",
- "model": "string",
- "model_name": "string",
- "node_uuids": [
- "string"
], - "nodes": [
- 0
], - "positions": [
- "string"
], - "rackable_unit_uuid": "string",
- "serial": "string"
}
]
Get the list of supported security modes for the SMTP server.
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/smtp/security_modes \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- "STARTTLS"
]
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/smtp \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "address": "string",
- "email_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "from_email_address": "string",
- "password": "string",
- "port": 0,
- "secure_mode": "STARTTLS",
- "server_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "username": "string"
}
Get a Rackable Unit with the specified id.
uuid required | string Uuid of a Rackable Unit |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/rackable_units/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "id": 0,
- "location": "string",
- "model": "string",
- "model_name": "string",
- "node_uuids": [
- "string"
], - "nodes": [
- 0
], - "positions": [
- "string"
], - "rackable_unit_uuid": "string",
- "serial": "string"
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/metro_witness \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "address_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "cluster_name": "string",
- "cluster_timestamp_usecs": 0,
- "cluster_uuid": "string",
- "ip_addresses": [
- "string"
], - "marked_for_removal": true,
- "nos_full_version": "string",
- "nos_version": "string",
- "password": "string",
- "username": "string",
- "uuid": "string",
- "witness_name": "string"
}
]
List domain fault tolerance status of the cluster for all the domains
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/domain_fault_tolerance_status \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "cluster_non_fault_tolerant_entries": 0,
- "cluster_under_replicated_data_bytes": 0,
- "component_fault_tolerance_status": {
- "property1": {
- "component_type": "EXTENT_GROUPS",
- "details": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "last_updated_time_in_usecs": 0,
- "number_of_failures_tolerable": 0,
- "under_computation": true
}, - "property2": {
- "component_type": "EXTENT_GROUPS",
- "details": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "last_updated_time_in_usecs": 0,
- "number_of_failures_tolerable": 0,
- "under_computation": true
}
}, - "domain_type": "RACK"
}
]
Modify the params of the cluster.
A Cluster instance
cluster_uuid | string |
object (patch.dto.appliance.configuration.ClusterDTO) | |
operation | string |
curl --request PATCH \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid": "string", "generic_dto": { "alert_summary": { "alert_summaries": { "property1": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "property2": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } } }, "count": 0 }, "all_hyperv_nodes_in_failover_cluster": true, "block_serials": [ "string" ], "cloudcluster": true, "cluster_arch": "string", "cluster_data_state": { "cluster_available": true, "cluster_data_available": true, "cluster_register_time_usecs": 0, "cluster_uuid": "string", "first_unavailable_time_usecs": 0, "last_alerts_data_transferred_usecs": 0, "last_arithmos_data_transferred_usecs": 0 }, "cluster_external_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "cluster_external_data_services_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "cluster_external_data_services_ipaddress": "string", "cluster_external_ipaddress": "string", "cluster_fully_qualified_domain_name": "string", "cluster_functions": [ "string" ], "cluster_gpus": [ "string" ], "cluster_incarnation_id": 0, "cluster_masquerading_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "cluster_masquerading_ipaddress": "string", "cluster_masquerading_port": 0, "cluster_redundancy_state": { "current_redundancy_factor": 0, "desired_redundancy_factor": 0, "redundancy_status": { "property1": true, "property2": true } }, "cluster_resiliency_preference": { "current_resiliency_preference": "DELAYED", "desired_resiliency_preference": "DELAYED" }, "cluster_usage_critical_alert_threshold_pct": 0, "cluster_usage_warning_alert_threshold_pct": 0, "cluster_uuid": "string", "common_criteria_mode": true, "credential": { "logon_name": "string", "password": "string" }, "data_in_transit_encryption_dto": { "enabled": true, "last_disabled_timestamp_secs": 0, "last_enabled_timestamp_secs": 0 }, "disable_degraded_node_monitoring": true, "domain": "string", "enable_efficient_metric_sync": true, "enable_lock_down": true, "enable_on_disk_dedup": true, "enable_password_remote_login_to_cluster": true, "enable_rebuild_reservation": true, "enable_rf1_container": true, "enable_shadow_clones": true, "encrypted": true, "enforce_rackable_unit_aware_placement": true, "external_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "external_subnet": "string", "fault_tolerance_domain_type": "RACK", "fingerprint_content_cache_percentage": 0, "full_version": "string", "global_nfs_white_list": [ "string" ], "global_nfs_white_list_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "gpu_driver_version": "string", "has_self_encrypting_drive": true, "health_summary": { "entity_type_summaries": [ { "checks_in_error": { "property1": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] }, "property2": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] } }, "detailed_check_summary": { "property1": {}, "property2": {} }, "entity_type": "PAGE", "filter_criteria": "string", "health_summary": { "property1": 0, "property2": 0 } } ], "health_check_summaries": { "property1": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 }, "property2": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 } }, "health_status": "Critical" }, "http_proxies": [ { "address": "string", "address_value": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "name": "string", "password": "string", "port": 0, "proxy_types": [ "string" ], "username": "string" } ], "hypervisor_lldp_config": {}, "hypervisor_security_compliance_config": {}, "hypervisor_types": [ "string" ], "id": "string", "internal_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "internal_subnet": "string", "is_lts": true, "is_nsenabled": true, "is_registered_to_pc": true, "is_ssp_enabled": true, "is_upgrade_in_progress": true, "iscsi_config": { "external_client_enabled": true }, "management_servers": [ { "drs_enabled": true, "drs_vm_behaviour": "UNKNOWN", "ha_enabled": true, "in_use": true, "ip_address": "string", "management_server_type": "VCENTER", "registered": true } ], "multicluster": true, "name": "string", "name_servers": [ "string" ], "name_servers_list": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "ncc_version": "string", "nos_cluster_and_hosts_domain_joined": true, "ntp_servers": [ "string" ], "ntp_servers_list": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "num_nodes": 0, "operation_mode": "NORMAL", "public_keys": [ { "key": "string", "name": "string" } ], "rackable_units": [ { "id": 0, "location": "string", "model": "string", "model_name": "string", "node_uuids": [ "string" ], "nodes": [ 0 ], "positions": [ "string" ], "rackable_unit_uuid": "string", "serial": "string" } ], "recycle_bin_dto": { "delete_intent_set": true, "recycle_bin_disabled_reason": "SPACE_THRESHOLD_EXCEEDED", "recycle_bin_disabled_timestamp_secs": 0, "recycle_bin_ttlsecs": 0 }, "security_compliance_config": { "enable_snmpv3_only": true }, "segmented_iscsi_data_services_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "segmented_iscsi_data_services_ipaddress": "string", "service_centers": [ { "ip_address": "string", "name": "string", "port": 0, "username": "string" } ], "smtp_server": { "address": "string", "email_status": { "last_changed_time_stamp_usecs": 0, "last_checked_time_stamp_usecs": 0, "last_successful_transmission_time_stamp_usecs": 0, "message": { "attributes": { "property1": "string", "property2": "string" }, "message": "string" }, "status": "SUCCESS" }, "from_email_address": "string", "password": "string", "port": 0, "secure_mode": "STARTTLS", "server_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "username": "string" }, "ssd_pinning_percentage_limit": 0, "stats": { "property1": "string", "property2": "string" }, "storage_type": "ALL_FLASH", "support_verbosity_type": "NOTHING", "target_version": "string", "threshold_for_storage_thin_provision": null, "timezone": "string", "usage_stats": { "property1": "string", "property2": "string" }, "uuid": "string", "version": "string" }, "operation": "string" }'
{- "value": true
}
Modify the SMTP server configuration.
An SMTP Server instance
cluster_uuid | string |
object (patch.dto.appliance.configuration.SmtpServerDTO) | |
operation | string |
curl --request PATCH \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/smtp \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid": "string", "generic_dto": { "address": "string", "email_status": { "last_changed_time_stamp_usecs": 0, "last_checked_time_stamp_usecs": 0, "last_successful_transmission_time_stamp_usecs": 0, "message": { "attributes": { "property1": "string", "property2": "string" }, "message": "string" }, "status": "SUCCESS" }, "from_email_address": "string", "password": "string", "port": 0, "secure_mode": "STARTTLS", "server_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "username": "string" }, "operation": "string" }'
{- "address": "string",
- "email_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "from_email_address": "string",
- "password": "string",
- "port": 0,
- "secure_mode": "STARTTLS",
- "server_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "username": "string"
}
Update a Metro Availability Witness
uuid required | string MA Witness uuid |
MA Witness update details
password | string |
uuid | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/metro_witness/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "password": "string", "uuid": "string" }'
{- "address_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "cluster_name": "string",
- "cluster_timestamp_usecs": 0,
- "cluster_uuid": "string",
- "ip_addresses": [
- "string"
], - "marked_for_removal": true,
- "nos_full_version": "string",
- "nos_version": "string",
- "password": "string",
- "username": "string",
- "uuid": "string",
- "witness_name": "string"
}
Update the params of the cluster.
A Cluster instance
object (update.dto.alerts.AlertSummaryDTO) | |
all_hyperv_nodes_in_failover_cluster | boolean |
block_serials | Array of strings |
cloudcluster | boolean |
cluster_arch | string |
object (update.dto.multicluster.ClusterDataStateDTO) | |
Array of objects (update.common.Address) | |
object (update.common.Address) | |
cluster_external_data_services_ipaddress | string |
cluster_external_ipaddress | string |
cluster_fully_qualified_domain_name | string |
cluster_functions | Array of strings unique Items Enum: "NDFS" "MULTICLUSTER" "CLOUDDATAGATEWAY" "MINERVA" "SINGLE_NODE" "TWO_NODE" "PLATFORM" |
cluster_gpus | Array of strings |
cluster_incarnation_id | integer <int64> |
object (update.common.Address) | |
cluster_masquerading_ipaddress | string |
cluster_masquerading_port | integer <int32> |
object (update.dto.appliance.configuration.ClusterRedundancyStateDTO) | |
object (update.dto.appliance.configuration.ClusterResiliencyPreferenceDTO) | |
cluster_usage_critical_alert_threshold_pct | integer <int32> |
cluster_usage_warning_alert_threshold_pct | integer <int32> |
cluster_uuid | string |
common_criteria_mode | boolean |
object (update.dto.hyperv.CredentialDTO) | |
object (update.dto.appliance.configuration.DataInTransitEncryptionDTO) | |
disable_degraded_node_monitoring | boolean |
domain | string |
enable_efficient_metric_sync | boolean |
enable_lock_down | boolean |
enable_on_disk_dedup | boolean |
enable_password_remote_login_to_cluster | boolean |
enable_rebuild_reservation | boolean |
enable_rf1_container | boolean |
enable_shadow_clones | boolean |
encrypted | boolean |
enforce_rackable_unit_aware_placement | boolean |
Array of objects (update.common.Address) | |
external_subnet | string |
fault_tolerance_domain_type | string Enum: "RACK" "RACKABLE_UNIT" "NODE" "DISK" "CLUSTER" "CUSTOM" |
fingerprint_content_cache_percentage | integer <int32> |
full_version | string |
global_nfs_white_list | Array of strings |
Array of objects (update.common.Address) | |
gpu_driver_version | string |
has_self_encrypting_drive | boolean |
object (update.dto.health.check.HealthSummaryDTO) | |
Array of objects (update.dto.appliance.configuration.HttpProxyDTO) | |
hypervisor_lldp_config | object (update.dto.appliance.configuration.ClusterDTO_HypervisorLldpConfigDTO) |
hypervisor_security_compliance_config | object (update.dto.appliance.configuration.ClusterDTO_HypervisorSecurityComplianceConfigDTO) |
hypervisor_types | Array of strings unique Items Enum: "kVMware" "kXen" "kHyperv" "kKvm" "kAmazonWebServices" "kVCenter" "kAcropolis" "kSCVMM" "kNull" |
id | string |
Array of objects (update.common.Address) | |
internal_subnet | string |
is_lts | boolean |
is_nsenabled | boolean |
is_registered_to_pc | boolean |
is_ssp_enabled | boolean |
is_upgrade_in_progress | boolean |
object (update.dto.appliance.configuration.ClusterDTO_IscsiConfig) | |
Array of objects (update.dto.uhura.ManagementServerInfoDTO) | |
multicluster | boolean |
name | string |
name_servers | Array of strings |
Array of objects (update.common.Address) | |
ncc_version | string |
nos_cluster_and_hosts_domain_joined | boolean |
ntp_servers | Array of strings |
Array of objects (update.common.Address) | |
num_nodes | integer <int64> |
operation_mode | string Enum: "NORMAL" "OVERRIDE" "READONLY" "STANDALONE" "SWITCH_TO_TWO_NODE" |
Array of objects (update.dto.appliance.configuration.ClusterDTO_PublicKeyDTO) | |
Array of objects (update.dto.appliance.configuration.RackableUnitDTO) | |
object (update.dto.appliance.configuration.RecycleBinDTO) | |
object (update.dto.appliance.configuration.ClusterDTO_SecurityComplianceConfigDTO) | |
Array of objects (update.common.Address) | |
segmented_iscsi_data_services_ipaddress | string |
Array of objects (update.dto.appliance.configuration.ServiceCenterDTO) | |
object (update.dto.appliance.configuration.SmtpServerDTO) | |
ssd_pinning_percentage_limit | integer <int32> |
object | |
storage_type | string Enum: "ALL_FLASH" "MIXED" "ALL_HDD" |
support_verbosity_type | string Enum: "NOTHING" "BASIC" "BASIC_COREDUMP" |
target_version | string |
threshold_for_storage_thin_provision | number <double> |
timezone | string |
object | |
uuid | string |
version | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "alert_summary": { "alert_summaries": { "property1": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "property2": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } } }, "count": 0 }, "all_hyperv_nodes_in_failover_cluster": true, "block_serials": [ "string" ], "cloudcluster": true, "cluster_arch": "string", "cluster_data_state": { "cluster_available": true, "cluster_data_available": true, "cluster_register_time_usecs": 0, "cluster_uuid": "string", "first_unavailable_time_usecs": 0, "last_alerts_data_transferred_usecs": 0, "last_arithmos_data_transferred_usecs": 0 }, "cluster_external_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "cluster_external_data_services_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "cluster_external_data_services_ipaddress": "string", "cluster_external_ipaddress": "string", "cluster_fully_qualified_domain_name": "string", "cluster_functions": [ "string" ], "cluster_gpus": [ "string" ], "cluster_incarnation_id": 0, "cluster_masquerading_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "cluster_masquerading_ipaddress": "string", "cluster_masquerading_port": 0, "cluster_redundancy_state": { "current_redundancy_factor": 0, "desired_redundancy_factor": 0, "redundancy_status": { "property1": true, "property2": true } }, "cluster_resiliency_preference": { "current_resiliency_preference": "DELAYED", "desired_resiliency_preference": "DELAYED" }, "cluster_usage_critical_alert_threshold_pct": 0, "cluster_usage_warning_alert_threshold_pct": 0, "cluster_uuid": "string", "common_criteria_mode": true, "credential": { "logon_name": "string", "password": "string" }, "data_in_transit_encryption_dto": { "enabled": true, "last_disabled_timestamp_secs": 0, "last_enabled_timestamp_secs": 0 }, "disable_degraded_node_monitoring": true, "domain": "string", "enable_efficient_metric_sync": true, "enable_lock_down": true, "enable_on_disk_dedup": true, "enable_password_remote_login_to_cluster": true, "enable_rebuild_reservation": true, "enable_rf1_container": true, "enable_shadow_clones": true, "encrypted": true, "enforce_rackable_unit_aware_placement": true, "external_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "external_subnet": "string", "fault_tolerance_domain_type": "RACK", "fingerprint_content_cache_percentage": 0, "full_version": "string", "global_nfs_white_list": [ "string" ], "global_nfs_white_list_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "gpu_driver_version": "string", "has_self_encrypting_drive": true, "health_summary": { "entity_type_summaries": [ { "checks_in_error": { "property1": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] }, "property2": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] } }, "detailed_check_summary": { "property1": {}, "property2": {} }, "entity_type": "PAGE", "filter_criteria": "string", "health_summary": { "property1": 0, "property2": 0 } } ], "health_check_summaries": { "property1": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 }, "property2": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 } }, "health_status": "Critical" }, "http_proxies": [ { "address": "string", "address_value": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "name": "string", "password": "string", "port": 0, "proxy_types": [ "string" ], "username": "string" } ], "hypervisor_lldp_config": {}, "hypervisor_security_compliance_config": {}, "hypervisor_types": [ "string" ], "id": "string", "internal_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "internal_subnet": "string", "is_lts": true, "is_nsenabled": true, "is_registered_to_pc": true, "is_ssp_enabled": true, "is_upgrade_in_progress": true, "iscsi_config": { "external_client_enabled": true }, "management_servers": [ { "drs_enabled": true, "drs_vm_behaviour": "UNKNOWN", "ha_enabled": true, "in_use": true, "ip_address": "string", "management_server_type": "VCENTER", "registered": true } ], "multicluster": true, "name": "string", "name_servers": [ "string" ], "name_servers_list": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "ncc_version": "string", "nos_cluster_and_hosts_domain_joined": true, "ntp_servers": [ "string" ], "ntp_servers_list": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "num_nodes": 0, "operation_mode": "NORMAL", "public_keys": [ { "key": "string", "name": "string" } ], "rackable_units": [ { "id": 0, "location": "string", "model": "string", "model_name": "string", "node_uuids": [ "string" ], "nodes": [ 0 ], "positions": [ "string" ], "rackable_unit_uuid": "string", "serial": "string" } ], "recycle_bin_dto": { "delete_intent_set": true, "recycle_bin_disabled_reason": "SPACE_THRESHOLD_EXCEEDED", "recycle_bin_disabled_timestamp_secs": 0, "recycle_bin_ttlsecs": 0 }, "security_compliance_config": { "enable_snmpv3_only": true }, "segmented_iscsi_data_services_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "segmented_iscsi_data_services_ipaddress": "string", "service_centers": [ { "ip_address": "string", "name": "string", "port": 0, "username": "string" } ], "smtp_server": { "address": "string", "email_status": { "last_changed_time_stamp_usecs": 0, "last_checked_time_stamp_usecs": 0, "last_successful_transmission_time_stamp_usecs": 0, "message": { "attributes": { "property1": "string", "property2": "string" }, "message": "string" }, "status": "SUCCESS" }, "from_email_address": "string", "password": "string", "port": 0, "secure_mode": "STARTTLS", "server_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "username": "string" }, "ssd_pinning_percentage_limit": 0, "stats": { "property1": "string", "property2": "string" }, "storage_type": "ALL_FLASH", "support_verbosity_type": "NOTHING", "target_version": "string", "threshold_for_storage_thin_provision": null, "timezone": "string", "usage_stats": { "property1": "string", "property2": "string" }, "uuid": "string", "version": "string" }'
{- "value": true
}
Update the Remote Support settings on the cluster.
A Timed Bool instance
duration | integer <int64> |
enabled | boolean |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/remote_support \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "duration": 0, "enabled": true }'
{- "value": true
}
Update the SMTP server configuration.
An SMTP Server instance
address | string |
object (update.dto.base.CommunicationStatusDTO) | |
from_email_address | string |
password | string |
port | integer <int32> |
secure_mode | string Enum: "STARTTLS" "SSL" "NONE" |
object (update.common.Address) | |
username | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/cluster/smtp \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "address": "string", "email_status": { "last_changed_time_stamp_usecs": 0, "last_checked_time_stamp_usecs": 0, "last_successful_transmission_time_stamp_usecs": 0, "message": { "attributes": { "property1": "string", "property2": "string" }, "message": "string" }, "status": "SUCCESS" }, "from_email_address": "string", "password": "string", "port": 0, "secure_mode": "STARTTLS", "server_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "username": "string" }'
{- "address": "string",
- "email_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "from_email_address": "string",
- "password": "string",
- "port": 0,
- "secure_mode": "STARTTLS",
- "server_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "username": "string"
}
Get a Cluster with the specified id.
id required | string Id of the cluster |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/clusters/{id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "all_hyperv_nodes_in_failover_cluster": true,
- "block_serials": [
- "string"
], - "cloudcluster": true,
- "cluster_arch": "string",
- "cluster_data_state": {
- "cluster_available": true,
- "cluster_data_available": true,
- "cluster_register_time_usecs": 0,
- "cluster_uuid": "string",
- "first_unavailable_time_usecs": 0,
- "last_alerts_data_transferred_usecs": 0,
- "last_arithmos_data_transferred_usecs": 0
}, - "cluster_external_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_external_ipaddress": "string",
- "cluster_fully_qualified_domain_name": "string",
- "cluster_functions": [
- "NDFS"
], - "cluster_gpus": [
- "string"
], - "cluster_incarnation_id": 0,
- "cluster_masquerading_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_masquerading_ipaddress": "string",
- "cluster_masquerading_port": 0,
- "cluster_redundancy_state": {
- "current_redundancy_factor": 0,
- "desired_redundancy_factor": 0,
- "redundancy_status": {
- "property1": true,
- "property2": true
}
}, - "cluster_resiliency_preference": {
- "current_resiliency_preference": "DELAYED",
- "desired_resiliency_preference": "DELAYED"
}, - "cluster_usage_critical_alert_threshold_pct": 0,
- "cluster_usage_warning_alert_threshold_pct": 0,
- "cluster_uuid": "string",
- "common_criteria_mode": true,
- "credential": {
- "logon_name": "string",
- "password": "string"
}, - "data_in_transit_encryption_dto": {
- "enabled": true,
- "last_disabled_timestamp_secs": 0,
- "last_enabled_timestamp_secs": 0
}, - "disable_degraded_node_monitoring": true,
- "domain": "string",
- "enable_efficient_metric_sync": true,
- "enable_lock_down": true,
- "enable_on_disk_dedup": true,
- "enable_password_remote_login_to_cluster": true,
- "enable_rebuild_reservation": true,
- "enable_rf1_container": true,
- "enable_shadow_clones": true,
- "encrypted": true,
- "enforce_rackable_unit_aware_placement": true,
- "external_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "external_subnet": "string",
- "fault_tolerance_domain_type": "RACK",
- "fingerprint_content_cache_percentage": 0,
- "full_version": "string",
- "global_nfs_white_list": [
- "string"
], - "global_nfs_white_list_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "gpu_driver_version": "string",
- "has_self_encrypting_drive": true,
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "http_proxies": [
- {
- "address": "string",
- "address_value": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "name": "string",
- "password": "string",
- "port": 65536,
- "proxy_types": [
- "HTTP"
], - "username": "string"
}
], - "hypervisor_lldp_config": { },
- "hypervisor_security_compliance_config": { },
- "hypervisor_types": [
- "kVMware"
], - "id": "string",
- "internal_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "internal_subnet": "string",
- "is_lts": true,
- "is_nsenabled": true,
- "is_registered_to_pc": true,
- "is_ssp_enabled": true,
- "is_upgrade_in_progress": true,
- "iscsi_config": {
- "external_client_enabled": true
}, - "management_servers": [
- {
- "drs_enabled": true,
- "drs_vm_behaviour": "UNKNOWN",
- "ha_enabled": true,
- "in_use": true,
- "ip_address": "string",
- "management_server_type": "VCENTER",
- "registered": true
}
], - "multicluster": true,
- "name": "string",
- "name_servers": [
- "string"
], - "name_servers_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "ncc_version": "string",
- "nos_cluster_and_hosts_domain_joined": true,
- "ntp_servers": [
- "string"
], - "ntp_servers_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "num_nodes": 0,
- "operation_mode": "NORMAL",
- "public_keys": [
- {
- "key": "string",
- "name": "string"
}
], - "rackable_units": [
- {
- "id": 0,
- "location": "string",
- "model": "string",
- "model_name": "string",
- "node_uuids": [
- "string"
], - "nodes": [
- 0
], - "positions": [
- "string"
], - "rackable_unit_uuid": "string",
- "serial": "string"
}
], - "recycle_bin_dto": {
- "delete_intent_set": true,
- "recycle_bin_disabled_reason": "SPACE_THRESHOLD_EXCEEDED",
- "recycle_bin_disabled_timestamp_secs": 0,
- "recycle_bin_ttlsecs": 604800
}, - "security_compliance_config": {
- "enable_snmpv3_only": true
}, - "segmented_iscsi_data_services_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "segmented_iscsi_data_services_ipaddress": "string",
- "service_centers": [
- {
- "ip_address": "string",
- "name": "string",
- "port": 65536,
- "username": "string"
}
], - "smtp_server": {
- "address": "string",
- "email_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "from_email_address": "string",
- "password": "string",
- "port": 0,
- "secure_mode": "STARTTLS",
- "server_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "username": "string"
}, - "ssd_pinning_percentage_limit": 0,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "storage_type": "ALL_FLASH",
- "support_verbosity_type": "NOTHING",
- "target_version": "string",
- "threshold_for_storage_thin_provision": 0.1,
- "timezone": "string",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "version": "string"
}
id required | string Id of a Cluster |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/clusters/{id}/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/clusters/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of clusters.
count | integer <int32> Number of Clusters to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
search_string | string Search string |
search_attribute_list | Array of strings Search attribute list |
page | integer <int32> Page number |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/clusters \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "all_hyperv_nodes_in_failover_cluster": true,
- "block_serials": [
- "string"
], - "cloudcluster": true,
- "cluster_arch": "string",
- "cluster_data_state": {
- "cluster_available": true,
- "cluster_data_available": true,
- "cluster_register_time_usecs": 0,
- "cluster_uuid": "string",
- "first_unavailable_time_usecs": 0,
- "last_alerts_data_transferred_usecs": 0,
- "last_arithmos_data_transferred_usecs": 0
}, - "cluster_external_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_external_ipaddress": "string",
- "cluster_fully_qualified_domain_name": "string",
- "cluster_functions": [
- "NDFS"
], - "cluster_gpus": [
- "string"
], - "cluster_incarnation_id": 0,
- "cluster_masquerading_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_masquerading_ipaddress": "string",
- "cluster_masquerading_port": 0,
- "cluster_redundancy_state": {
- "current_redundancy_factor": 0,
- "desired_redundancy_factor": 0,
- "redundancy_status": {
- "property1": true,
- "property2": true
}
}, - "cluster_resiliency_preference": {
- "current_resiliency_preference": "DELAYED",
- "desired_resiliency_preference": "DELAYED"
}, - "cluster_usage_critical_alert_threshold_pct": 0,
- "cluster_usage_warning_alert_threshold_pct": 0,
- "cluster_uuid": "string",
- "common_criteria_mode": true,
- "credential": {
- "logon_name": "string",
- "password": "string"
}, - "data_in_transit_encryption_dto": {
- "enabled": true,
- "last_disabled_timestamp_secs": 0,
- "last_enabled_timestamp_secs": 0
}, - "disable_degraded_node_monitoring": true,
- "domain": "string",
- "enable_efficient_metric_sync": true,
- "enable_lock_down": true,
- "enable_on_disk_dedup": true,
- "enable_password_remote_login_to_cluster": true,
- "enable_rebuild_reservation": true,
- "enable_rf1_container": true,
- "enable_shadow_clones": true,
- "encrypted": true,
- "enforce_rackable_unit_aware_placement": true,
- "external_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "external_subnet": "string",
- "fault_tolerance_domain_type": "RACK",
- "fingerprint_content_cache_percentage": 0,
- "full_version": "string",
- "global_nfs_white_list": [
- "string"
], - "global_nfs_white_list_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "gpu_driver_version": "string",
- "has_self_encrypting_drive": true,
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "http_proxies": [
- {
- "address": "string",
- "address_value": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": null,
- "name": null,
- "offset": null,
- "signature": null,
- "type": null,
- "unshared": null
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "name": "string",
- "password": "string",
- "port": 65536,
- "proxy_types": [
- "HTTP"
], - "username": "string"
}
], - "hypervisor_lldp_config": { },
- "hypervisor_security_compliance_config": { },
- "hypervisor_types": [
- "kVMware"
], - "id": "string",
- "internal_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "internal_subnet": "string",
- "is_lts": true,
- "is_nsenabled": true,
- "is_registered_to_pc": true,
- "is_ssp_enabled": true,
- "is_upgrade_in_progress": true,
- "iscsi_config": {
- "external_client_enabled": true
}, - "management_servers": [
- {
- "drs_enabled": true,
- "drs_vm_behaviour": "UNKNOWN",
- "ha_enabled": true,
- "in_use": true,
- "ip_address": "string",
- "management_server_type": "VCENTER",
- "registered": true
}
], - "multicluster": true,
- "name": "string",
- "name_servers": [
- "string"
], - "name_servers_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "ncc_version": "string",
- "nos_cluster_and_hosts_domain_joined": true,
- "ntp_servers": [
- "string"
], - "ntp_servers_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "num_nodes": 0,
- "operation_mode": "NORMAL",
- "public_keys": [
- {
- "key": "string",
- "name": "string"
}
], - "rackable_units": [
- {
- "id": 0,
- "location": "string",
- "model": "string",
- "model_name": "string",
- "node_uuids": [
- "string"
], - "nodes": [
- 0
], - "positions": [
- "string"
], - "rackable_unit_uuid": "string",
- "serial": "string"
}
], - "recycle_bin_dto": {
- "delete_intent_set": true,
- "recycle_bin_disabled_reason": "SPACE_THRESHOLD_EXCEEDED",
- "recycle_bin_disabled_timestamp_secs": 0,
- "recycle_bin_ttlsecs": 604800
}, - "security_compliance_config": {
- "enable_snmpv3_only": true
}, - "segmented_iscsi_data_services_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "segmented_iscsi_data_services_ipaddress": "string",
- "service_centers": [
- {
- "ip_address": "string",
- "name": "string",
- "port": 65536,
- "username": "string"
}
], - "smtp_server": {
- "address": "string",
- "email_status": {
- "last_changed_time_stamp_usecs": 0,
- "last_checked_time_stamp_usecs": 0,
- "last_successful_transmission_time_stamp_usecs": 0,
- "message": {
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "message": "string"
}, - "status": "SUCCESS"
}, - "from_email_address": "string",
- "password": "string",
- "port": 0,
- "secure_mode": "STARTTLS",
- "server_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "username": "string"
}, - "ssd_pinning_percentage_limit": 0,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "storage_type": "ALL_FLASH",
- "support_verbosity_type": "NOTHING",
- "target_version": "string",
- "threshold_for_storage_thin_provision": 0.1,
- "timezone": "string",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "version": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
id required | string Id of a Cluster |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/clusters/{id}/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/clusters/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
If start time and end time are included in the query string, then historical stats are retrieved. Otherwise, the latest stats are retrieved.
id required | string Id of a Cluster |
metrics required | Array of strings List of metrics |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
interval_in_secs | integer <int32> Sampling interval of stats |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/clusters/{id}/stats \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "stats_specific_responses": [
- {
- "interval_in_secs": 0,
- "message": "string",
- "metric": "string",
- "start_time_in_usecs": 0,
- "successful": true,
- "values": [
- 0
]
}
]
}
Download encryption key encrypted with the password.
password used to encrypt the key.
password | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption/download_encryption_key \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "password": "string" }'
{- "backup_data": [
- "string"
]
}
Enable encryption on the cluster.
Desired cluster protection status
software_encryption_scope | string Enum: "CLUSTER" "STORAGE_CONTAINER" |
value | boolean |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption/enable \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "software_encryption_scope": "CLUSTER", "value": true }'
{- "value": true
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "desired_password_protection": true,
- "disk_encryption_status": {
- "property1": true,
- "property2": true
}, - "is_cluster_empty": true,
- "is_ready_for_password_protection": true,
- "is_ready_for_software_encryption": true,
- "pckey_manager_status": "UNREGISTERED",
- "software_encryption_scope": "CLUSTER",
- "storage_container_encryption_status": {
- "property1": true,
- "property2": true
}
}
Get recent certificate test results.
host_uuids | Array of strings List of Host uuids |
kms_server_names | Array of strings List of Key Management Server names |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption/recent_certificate_test_results \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "key_management_server_name": "string",
- "key_management_server_uuid": "string",
- "node_id": "string",
- "node_uuid": "string",
- "result_list": [
- {
- "ip_address": "string",
- "message": "string",
- "port": 0,
- "test_status": "string"
}
]
}
]
Software Rekey request
change_wrapping_key | boolean |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption/software/rekey \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "change_wrapping_key": true }'
{- "task_uuid": "string"
}
Sets new passwords for encryption capable disks
List of disk uuids on which rekey needs to be performed
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption/rekey \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Test encryption configuration of the cluster.
List of host ids and key management server names on which test to be performed
node_id_list | Array of strings |
node_uuid_list | Array of strings |
server_list | Array of strings |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption/test \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "node_id_list": [ "string" ], "node_uuid_list": [ "string" ], "server_list": [ "string" ] }'
{- "detailed_test_response": {
- "property1": {
- "key_management_server_test_response_map": {
- "property1": {
- "ip_address_to_test_result_map": {
- "property1": true,
- "property2": true
}, - "key_management_server_name": "string"
}, - "property2": {
- "ip_address_to_test_result_map": {
- "property1": true,
- "property2": true
}, - "key_management_server_name": "string"
}
}, - "node_id": "string",
- "node_uuid": "string"
}, - "property2": {
- "key_management_server_test_response_map": {
- "property1": {
- "ip_address_to_test_result_map": {
- "property1": true,
- "property2": true
}, - "key_management_server_name": "string"
}, - "property2": {
- "ip_address_to_test_result_map": {
- "property1": true,
- "property2": true
}, - "key_management_server_name": "string"
}
}, - "node_id": "string",
- "node_uuid": "string"
}
}, - "has_failures": true
}
Add certificates to the cluster.
key_management_server_name required | string Key Management Server name |
certificate_file required | string <binary> Certificate file |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption_certificates/svm_certificates \ --header 'Accept: application/json' \ --header 'Content-Type: multipart/form-data' \ --data '{ "certificate_file": null }'
{- "value": "string"
}
Add certificates to the cluster via multi-file upload.
Certificate list
object | |
key_management_server_name | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption_certificates/svm_certificates/multi_file \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "certificate_map": { "property1": "string", "property2": "string" }, "key_management_server_name": "string" }'
{- "value": "string"
}
Add trusted CA certificate to the cluster.
name required | string name |
certificate_file required | string <binary> Certificate file |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption_certificates/ca_certificates \ --header 'Accept: application/json' \ --header 'Content-Type: multipart/form-data' \ --data '{ "certificate_file": null }'
{- "certificate": "string",
- "name": "string"
}
Delete a CA certificate from cluster.
name required | string Certificate Authority name |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption_certificates/ca_certificates/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Delete a svm certificate from cluster.
node_uuid required | string Id of the node on which certificate is installed |
server_name required | string Key management Server name for which certificate is installed |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption_certificates/svm_certificate \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Download CSR files from cluster
node_ip required | string node ip address |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption_certificates/csr_for_discovered_node \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
"string"
Download CSR files from cluster
node_uuid_list | Array of strings List of node ids |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption_certificates/csrs \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{ }
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption_certificates/ca_certificates \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "certificate": "string",
- "name": "string"
}
]
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption_certificates/certification_information \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "city": "string",
- "country_code": "string",
- "domain_name": "string",
- "email_address": "string",
- "organization_name": "string",
- "organizational_unit_list": [
- "string"
], - "state": "string"
}
Replace svm certificate on the cluster.
key_management_server_name required | string Key Management Server name |
node_uuid required | string ServiceVmId of the node |
certificate_file required | string <binary> Certificate file |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption_certificates/svm_certificates/replace \ --header 'Accept: application/json' \ --header 'Content-Type: multipart/form-data' \ --data '{ "certificate_file": null }'
{- "value": "string"
}
Update the Certification information.
CertificationInformation instance
city | string |
country_code | string |
domain_name | string |
email_address | string |
organization_name | string |
organizational_unit_list | Array of strings |
state | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/data_at_rest_encryption_certificates/certification_information \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "city": "string", "country_code": "string", "domain_name": "string", "email_address": "string", "organization_name": "string", "organizational_unit_list": [ "string" ], "state": "string" }'
{- "city": "string",
- "country_code": "string",
- "domain_name": "string",
- "email_address": "string",
- "organization_name": "string",
- "organizational_unit_list": [
- "string"
], - "state": "string"
}
Get a Disk with the specified id.
uuid required | string Uuid of the Disk |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/disks/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "cluster_uuid": "string",
- "cvm_ip_address": "string",
- "data_migrated": true,
- "disk_hardware_config": {
- "background_operation": "string",
- "bad": true,
- "boot_disk": true,
- "can_add_as_new_disk": true,
- "can_add_as_old_disk": true,
- "current_firmware_version": "string",
- "disk_id": "string",
- "disk_uuid": "string",
- "location": 0,
- "model": "string",
- "mount_path": "string",
- "mounted": true,
- "only_boot_disk": true,
- "serial_number": "string",
- "target_firmware_version": "string",
- "under_diagnosis": true,
- "vendor": "string"
}, - "disk_size": 0,
- "disk_status": "NORMAL",
- "disk_uuid": "string",
- "dynamic_ring_changing_node": {
- "acropolis_connection_state": "string",
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": null,
- "condition_type": null,
- "data_type": null,
- "entity_id": null,
- "entity_type": null,
- "metric_category": null,
- "metric_display_name": null,
- "metric_name": null,
- "metric_value_details": [ ],
- "unit": null
}
], - "severity_trails": [
- {
- "severity": null,
- "severity_change_timestamp_in_usecs": null
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [ ],
- "error_info": null,
- "metadata": null
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": null,
- "condition_type": null,
- "data_type": null,
- "entity_id": null,
- "entity_type": null,
- "metric_category": null,
- "metric_display_name": null,
- "metric_name": null,
- "metric_value_details": [ ],
- "unit": null
}
], - "severity_trails": [
- {
- "severity": null,
- "severity_change_timestamp_in_usecs": null
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [ ],
- "error_info": null,
- "metadata": null
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "backplane_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "backplane_ip": "string",
- "bios_model": "string",
- "bios_version": "string",
- "block_location": "string",
- "block_model": "string",
- "block_model_name": "string",
- "block_serial": "string",
- "bmc_model": "string",
- "bmc_version": "string",
- "boot_time_in_usecs": 0,
- "cluster_uuid": "string",
- "controller_vm_backplane_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "controller_vm_backplane_ip": "string",
- "cpu_capacity_in_hz": 0,
- "cpu_frequency_in_hz": 0,
- "cpu_model": "string",
- "default_vhd_container_id": "string",
- "default_vhd_container_uuid": "string",
- "default_vhd_location": "string",
- "default_vhd_storage_container_id": "string",
- "default_vhd_storage_container_uuid": "string",
- "default_vm_container_id": "string",
- "default_vm_container_uuid": "string",
- "default_vm_location": "string",
- "default_vm_storage_container_id": "string",
- "default_vm_storage_container_uuid": "string",
- "disk_hardware_configs": {
- "property1": {
- "background_operation": "string",
- "bad": true,
- "boot_disk": true,
- "can_add_as_new_disk": true,
- "can_add_as_old_disk": true,
- "current_firmware_version": "string",
- "disk_id": "string",
- "disk_uuid": "string",
- "location": 0,
- "model": "string",
- "mount_path": "string",
- "mounted": true,
- "only_boot_disk": true,
- "serial_number": "string",
- "target_firmware_version": "string",
- "under_diagnosis": true,
- "vendor": "string"
}, - "property2": {
- "background_operation": "string",
- "bad": true,
- "boot_disk": true,
- "can_add_as_new_disk": true,
- "can_add_as_old_disk": true,
- "current_firmware_version": "string",
- "disk_id": "string",
- "disk_uuid": "string",
- "location": 0,
- "model": "string",
- "mount_path": "string",
- "mounted": true,
- "only_boot_disk": true,
- "serial_number": "string",
- "target_firmware_version": "string",
- "under_diagnosis": true,
- "vendor": "string"
}
}, - "dynamic_ring_changing_node": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "failover_cluster_fqdn": "string",
- "failover_cluster_node_state": "string",
- "gpu_driver_version": "string",
- "has_csr": true,
- "hba_firmwares_list": [
- {
- "hba_model": "string",
- "hba_version": "string"
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "host_gpus": [
- "string"
], - "host_in_maintenance_mode": true,
- "host_maintenance_mode_reason": "string",
- "host_nic_ids": [
- "string"
], - "host_type": "HYPER_CONVERGED",
- "hypervisor_address": "string",
- "hypervisor_address_value": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "hypervisor_full_name": "string",
- "hypervisor_key": "string",
- "hypervisor_password": "string",
- "hypervisor_state": "string",
- "hypervisor_type": "string",
- "hypervisor_username": "string",
- "ipmi_address": "string",
- "ipmi_address_value": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "ipmi_password": "string",
- "ipmi_username": "string",
- "is_degraded": true,
- "is_hardware_virtualized": true,
- "is_secure_booted": true,
- "key_management_device_to_certificate_status": {
- "property1": true,
- "property2": true
}, - "management_server_name": "string",
- "memory_capacity_in_bytes": 0,
- "metadata_store_status": "string",
- "metadata_store_status_message": "string",
- "monitored": true,
- "name": "string",
- "num_cpu_cores": 0,
- "num_cpu_sockets": 0,
- "num_cpu_threads": 0,
- "num_vms": 0,
- "oplog_disk_pct": 0.1,
- "oplog_disk_size": 0,
- "position": {
- "name": "string",
- "ordinal": 0,
- "physical_position": "C"
}, - "rdma_backplane_address_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "rdma_backplane_ips": [
- "string"
], - "reboot_pending": true,
- "removal_status": [
- "NA"
], - "serial": "string",
- "service_vmexternal_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "service_vmexternal_ip": "string",
- "service_vmid": "string",
- "service_vmnat_ip": "string",
- "service_vmnat_port": 0,
- "state": "NEW",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vzone_name": "string"
}, - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "host_name": "string",
- "id": "string",
- "last_node_uuid": "string",
- "last_service_vmid": "string",
- "location": 0,
- "marked_for_removal": true,
- "mount_path": "string",
- "node_name": "string",
- "node_uuid": "string",
- "online": true,
- "password_protected": true,
- "self_encrypting_drive": true,
- "self_managed_nvme": true,
- "service_vmid": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "storage_pool_id": "string",
- "storage_pool_uuid": "string",
- "storage_tier_name": "string",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}
}
uuid required | string Uuid of a Disk |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/disks/{uuid}/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/disks/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of Disks configured in the cluster.
count | integer <int32> Number of Disks to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
search_string | string Search string |
search_attribute_list | Array of strings Search attribute list |
page | integer <int32> Page number |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/disks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "cluster_uuid": "string",
- "cvm_ip_address": "string",
- "data_migrated": true,
- "disk_hardware_config": {
- "background_operation": "string",
- "bad": true,
- "boot_disk": true,
- "can_add_as_new_disk": true,
- "can_add_as_old_disk": true,
- "current_firmware_version": "string",
- "disk_id": "string",
- "disk_uuid": "string",
- "location": 0,
- "model": "string",
- "mount_path": "string",
- "mounted": true,
- "only_boot_disk": true,
- "serial_number": "string",
- "target_firmware_version": "string",
- "under_diagnosis": true,
- "vendor": "string"
}, - "disk_size": 0,
- "disk_status": "NORMAL",
- "disk_uuid": "string",
- "dynamic_ring_changing_node": {
- "acropolis_connection_state": "string",
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- null
], - "alert_details": {
- "metric_details": [ ],
- "severity_trails": [ ]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- null
], - "check_id": "string",
- "classifications": [
- null
], - "cluster_uuid": "string",
- "context_types": [
- null
], - "context_values": [
- null
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- null
], - "entity_types": [
- null
], - "entity_uuids": [
- null
], - "id": "string",
- "impact": "string",
- "impact_types": [
- null
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- null
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- null
], - "alert_details": {
- "metric_details": [ ],
- "severity_trails": [ ]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- null
], - "check_id": "string",
- "classifications": [
- null
], - "cluster_uuid": "string",
- "context_types": [
- null
], - "context_values": [
- null
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- null
], - "entity_types": [
- null
], - "entity_uuids": [
- null
], - "id": "string",
- "impact": "string",
- "impact_types": [
- null
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- null
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "backplane_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": null,
- "name": null,
- "offset": null,
- "signature": null,
- "type": null,
- "unshared": null
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "backplane_ip": "string",
- "bios_model": "string",
- "bios_version": "string",
- "block_location": "string",
- "block_model": "string",
- "block_model_name": "string",
- "block_serial": "string",
- "bmc_model": "string",
- "bmc_version": "string",
- "boot_time_in_usecs": 0,
- "cluster_uuid": "string",
- "controller_vm_backplane_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": null,
- "name": null,
- "offset": null,
- "signature": null,
- "type": null,
- "unshared": null
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "controller_vm_backplane_ip": "string",
- "cpu_capacity_in_hz": 0,
- "cpu_frequency_in_hz": 0,
- "cpu_model": "string",
- "default_vhd_container_id": "string",
- "default_vhd_container_uuid": "string",
- "default_vhd_location": "string",
- "default_vhd_storage_container_id": "string",
- "default_vhd_storage_container_uuid": "string",
- "default_vm_container_id": "string",
- "default_vm_container_uuid": "string",
- "default_vm_location": "string",
- "default_vm_storage_container_id": "string",
- "default_vm_storage_container_uuid": "string",
- "disk_hardware_configs": {
- "property1": {
- "background_operation": "string",
- "bad": true,
- "boot_disk": true,
- "can_add_as_new_disk": true,
- "can_add_as_old_disk": true,
- "current_firmware_version": "string",
- "disk_id": "string",
- "disk_uuid": "string",
- "location": 0,
- "model": "string",
- "mount_path": "string",
- "mounted": true,
- "only_boot_disk": true,
- "serial_number": "string",
- "target_firmware_version": "string",
- "under_diagnosis": true,
- "vendor": "string"
}, - "property2": {
- "background_operation": "string",
- "bad": true,
- "boot_disk": true,
- "can_add_as_new_disk": true,
- "can_add_as_old_disk": true,
- "current_firmware_version": "string",
- "disk_id": "string",
- "disk_uuid": "string",
- "location": 0,
- "model": "string",
- "mount_path": "string",
- "mounted": true,
- "only_boot_disk": true,
- "serial_number": "string",
- "target_firmware_version": "string",
- "under_diagnosis": true,
- "vendor": "string"
}
}, - "dynamic_ring_changing_node": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "failover_cluster_fqdn": "string",
- "failover_cluster_node_state": "string",
- "gpu_driver_version": "string",
- "has_csr": true,
- "hba_firmwares_list": [
- {
- "hba_model": "string",
- "hba_version": "string"
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- null
], - "node_level": [
- null
]
}, - "property2": {
- "cluster_level": [
- null
], - "node_level": [
- null
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "host_gpus": [
- "string"
], - "host_in_maintenance_mode": true,
- "host_maintenance_mode_reason": "string",
- "host_nic_ids": [
- "string"
], - "host_type": "HYPER_CONVERGED",
- "hypervisor_address": "string",
- "hypervisor_address_value": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": null,
- "name": null,
- "offset": null,
- "signature": null,
- "type": null,
- "unshared": null
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "hypervisor_full_name": "string",
- "hypervisor_key": "string",
- "hypervisor_password": "string",
- "hypervisor_state": "string",
- "hypervisor_type": "string",
- "hypervisor_username": "string",
- "ipmi_address": "string",
- "ipmi_address_value": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": null,
- "name": null,
- "offset": null,
- "signature": null,
- "type": null,
- "unshared": null
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "ipmi_password": "string",
- "ipmi_username": "string",
- "is_degraded": true,
- "is_hardware_virtualized": true,
- "is_secure_booted": true,
- "key_management_device_to_certificate_status": {
- "property1": true,
- "property2": true
}, - "management_server_name": "string",
- "memory_capacity_in_bytes": 0,
- "metadata_store_status": "string",
- "metadata_store_status_message": "string",
- "monitored": true,
- "name": "string",
- "num_cpu_cores": 0,
- "num_cpu_sockets": 0,
- "num_cpu_threads": 0,
- "num_vms": 0,
- "oplog_disk_pct": 0.1,
- "oplog_disk_size": 0,
- "position": {
- "name": "string",
- "ordinal": 0,
- "physical_position": "C"
}, - "rdma_backplane_address_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": null,
- "name": null,
- "offset": null,
- "signature": null,
- "type": null,
- "unshared": null
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "rdma_backplane_ips": [
- "string"
], - "reboot_pending": true,
- "removal_status": [
- "NA"
], - "serial": "string",
- "service_vmexternal_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": null,
- "name": null,
- "offset": null,
- "signature": null,
- "type": null,
- "unshared": null
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "service_vmexternal_ip": "string",
- "service_vmid": "string",
- "service_vmnat_ip": "string",
- "service_vmnat_port": 0,
- "state": "NEW",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vzone_name": "string"
}, - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "host_name": "string",
- "id": "string",
- "last_node_uuid": "string",
- "last_service_vmid": "string",
- "location": 0,
- "marked_for_removal": true,
- "mount_path": "string",
- "node_name": "string",
- "node_uuid": "string",
- "online": true,
- "password_protected": true,
- "self_encrypting_drive": true,
- "self_managed_nvme": true,
- "service_vmid": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "storage_pool_id": "string",
- "storage_pool_uuid": "string",
- "storage_tier_name": "string",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
uuid required | string Uuid of a Disk |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/disks/{uuid}/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/disks/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
If start time and end time are included in the query string, then historical stats are retrieved. Otherwise, the latest stats are retrieved.
uuid required | string Uuid of a Disk |
metrics required | Array of strings List of metrics |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
interval_in_secs | integer <int32> Sampling interval of stats |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/disks/{uuid}/stats \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "stats_specific_responses": [
- {
- "interval_in_secs": 0,
- "message": "string",
- "metric": "string",
- "start_time_in_usecs": 0,
- "successful": true,
- "values": [
- 0
]
}
]
}
Mark specified Disk for removal. Use force option to ignore all the system validations.
uuid required | string Uuid of a Disk |
force | boolean Force the operation |
bypass_upgrade_check | boolean Skip upgrade check |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/disks/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Acknowledge Event with the specified Id.
id required | string Event Id |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/events/{id}/acknowledge \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Acknowledge events using a filter criteria.
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
severity | string Severity |
entity_type | string Entity Type |
entity_type_ids | string Entity Type Ids |
count | integer <int32> Maximum number of events |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/events/acknowledge \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "alert_status_list": [
- {
- "id": "string",
- "message": "string",
- "successful": true
}
], - "num_failed_updates": 0,
- "num_successful_updates": 0
}
Get the list of Events generated in the cluster.
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
entity_type | string Entity type |
entity_ids | string Entity ids |
event_ids | string Event ids |
detailed_info | boolean Get detailed info |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/file_groups \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "error_details": {
- "entity_id": "string",
- "error_code": 0,
- "error_message": "string"
}, - "file_clone_paths": [
- "string"
], - "file_group_uuid": "string",
- "protection_domain_name": "string",
- "snapshot_id": "string",
- "snapshot_uuid": "string",
- "state": "NOT_STARTED",
- "task_uuid": "string",
- "v_store_path_prefixes": [
- "string"
], - "vm_ids": [
- "string"
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Delete all the entities associated with this file group (Nutanix fast clone). This is an overruling API, which deletes all the entities in the live namespace associated with this file group. This operation is irreversible, hence users caution is required.
uuid required | string UUID of file group |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/file_groups/{uuid}/delete_files \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
vm_uuid required | string Uuid of the VM |
snapshot_id required | integer <int64> Id of the snapshot |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/flr/{vm_uuid}/attached_disks/{snapshot_id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "attached_disk_label": "string",
- "attached_disk_uuid": "string",
- "disk_detach_time": 0,
- "original_disk_label": "string",
- "original_disk_uuid": "string",
- "snapshot_id": 0
}
]
vm_uuid required | string Uuid of the VM |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/flr/{vm_uuid}/attached_disks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "attached_disk_label": "string",
- "attached_disk_uuid": "string",
- "disk_detach_time": 0,
- "original_disk_label": "string",
- "original_disk_uuid": "string",
- "snapshot_id": 0
}
]
vm_uuid required | string Uuid of the VM |
snapshot_count | integer <int32> Snapshot Count |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/flr/{vm_uuid}/snapshots \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "disk_labels": [
- "string"
], - "disk_uuids": [
- "string"
], - "flr_capabale": true,
- "locally_avaiable": true,
- "remote_sites": [
- "string"
], - "snapshot_create_time": 0,
- "snapshot_expiry_time": 0,
- "snapshot_id": 0
}
]
vm_uuid required | string Uuid of the VM |
Snapshot id and specific disk to attach
disk_label | string |
snapshot_id | integer <int64> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/flr/{vm_uuid}/attach_disk \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "disk_label": "string", "snapshot_id": 0 }'
{- "value": true
}
vm_uuid required | string Uuid of the VM |
Specific disk to detach
attached_disk_label | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/flr/{vm_uuid}/detach_disk \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "attached_disk_label": "string" }'
{- "value": true
}
HA configuration
enable_failover | boolean |
evacuation_option | string Enum: "POWER_OFF" "COLD_MIGRATE" "LIVE_MIGRATE" |
logical_timestamp | integer <int64> |
num_host_failures_to_tolerate | integer <int64> |
reservation_type | string Enum: "RESERVE_HOSTS" "RESERVE_SEGMENTS" "NO_RESERVATIONS" |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/ha \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "enable_failover": true, "evacuation_option": "POWER_OFF", "logical_timestamp": 0, "num_host_failures_to_tolerate": 0, "reservation_type": "RESERVE_HOSTS" }'
{- "task_uuid": "string"
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/ha \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "failover_enabled": true,
- "failover_in_progress_host_uuids": [
- "string"
], - "ha_state": "HIGHLY_AVAILABLE",
- "logical_timestamp": 0,
- "num_host_failures_to_tolerate": 0,
- "reservation_type": "RESERVE_HOSTS",
- "reserved_host_uuids": [
- "string"
]
}
Get the health check with the specified id.
id required | string Id of the health check |
global_config | boolean Whether to get the global config list or not. |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/health_checks/{id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "affected_entity_types": [
- "string"
], - "alert_config_exception_groups": [
- {
- "auto_resolve": "ENABLED",
- "cluster_uuids": [
- "string"
], - "configurable_parameters": [
- {
- "parameter_boolean_value": true,
- "parameter_default_boolean_value": true,
- "parameter_default_long_value": 0,
- "parameter_default_string_value": "string",
- "parameter_display_name": "string",
- "parameter_long_value": 0,
- "parameter_name": "string",
- "parameter_string_value": "string",
- "parameter_unit": "string",
- "parameter_valid_values": [
- "string"
], - "severity": "string"
}
], - "severity_threshold_infos": [
- {
- "enabled": true,
- "severity": "string"
}
]
}
], - "alert_configurable_parameters": [
- {
- "parameter_boolean_value": true,
- "parameter_default_boolean_value": true,
- "parameter_default_long_value": 0,
- "parameter_default_string_value": "string",
- "parameter_display_name": "string",
- "parameter_long_value": 0,
- "parameter_name": "string",
- "parameter_string_value": "string",
- "parameter_unit": "string",
- "parameter_valid_values": [
- "string"
], - "severity": "string"
}
], - "alert_type_id": "string",
- "applicable_for_multi_cluster": true,
- "applicable_for_single_cluster": true,
- "auto_resolve": "ENABLED",
- "category_types": [
- "string"
], - "causes": [
- "string"
], - "check_type": "SCHEDULED",
- "classifications": [
- "string"
], - "description": "string",
- "enabled": true,
- "exception_count": 0,
- "id": "string",
- "impact_types": [
- "string"
], - "impacts": [
- "string"
], - "is_global_config": true,
- "is_user_defined": true,
- "kb_list": [
- "string"
], - "message": "string",
- "metrics": [
- {
- "display_name": "string",
- "name": "string"
}
], - "modified_by_username": "string",
- "modified_time_stamp_in_usecs": 0,
- "name": "string",
- "parameters": {
- "property1": {
- "display_name": "string",
- "name": "string",
- "valid_values_range": [
- "string"
], - "value": "string"
}, - "property2": {
- "display_name": "string",
- "name": "string",
- "valid_values_range": [
- "string"
], - "value": "string"
}
}, - "policy_uuid": "string",
- "resolutions": [
- "string"
], - "schedule_interval_in_secs": 0,
- "scope": "string",
- "severity_threshold_infos": [
- {
- "enabled": true,
- "severity": "string"
}
], - "sub_category_types": [
- "string"
], - "title": "string"
}
Get the list of Health Checks configured in the cluster.
check_ids | Array of strings Check Ids |
global_config | boolean Whether to get the global config list or not. |
include_internal_checks | boolean Whether to include internal checks or not. |
category_types | Array of strings Categories of the Health Check. |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/health_checks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "affected_entity_types": [
- "string"
], - "alert_config_exception_groups": [
- {
- "auto_resolve": "ENABLED",
- "cluster_uuids": [
- "string"
], - "configurable_parameters": [
- {
- "parameter_boolean_value": true,
- "parameter_default_boolean_value": true,
- "parameter_default_long_value": 0,
- "parameter_default_string_value": "string",
- "parameter_display_name": "string",
- "parameter_long_value": 0,
- "parameter_name": "string",
- "parameter_string_value": "string",
- "parameter_unit": "string",
- "parameter_valid_values": [
- "string"
], - "severity": "string"
}
], - "severity_threshold_infos": [
- {
- "enabled": true,
- "severity": "string"
}
]
}
], - "alert_configurable_parameters": [
- {
- "parameter_boolean_value": true,
- "parameter_default_boolean_value": true,
- "parameter_default_long_value": 0,
- "parameter_default_string_value": "string",
- "parameter_display_name": "string",
- "parameter_long_value": 0,
- "parameter_name": "string",
- "parameter_string_value": "string",
- "parameter_unit": "string",
- "parameter_valid_values": [
- "string"
], - "severity": "string"
}
], - "alert_type_id": "string",
- "applicable_for_multi_cluster": true,
- "applicable_for_single_cluster": true,
- "auto_resolve": "ENABLED",
- "category_types": [
- "string"
], - "causes": [
- "string"
], - "check_type": "SCHEDULED",
- "classifications": [
- "string"
], - "description": "string",
- "enabled": true,
- "exception_count": 0,
- "id": "string",
- "impact_types": [
- "string"
], - "impacts": [
- "string"
], - "is_global_config": true,
- "is_user_defined": true,
- "kb_list": [
- "string"
], - "message": "string",
- "metrics": [
- {
- "display_name": "string",
- "name": "string"
}
], - "modified_by_username": "string",
- "modified_time_stamp_in_usecs": 0,
- "name": "string",
- "parameters": {
- "property1": {
- "display_name": "string",
- "name": "string",
- "valid_values_range": [
- "string"
], - "value": "string"
}, - "property2": {
- "display_name": "string",
- "name": "string",
- "valid_values_range": [
- "string"
], - "value": "string"
}
}, - "policy_uuid": "string",
- "resolutions": [
- "string"
], - "schedule_interval_in_secs": 0,
- "scope": "string",
- "severity_threshold_infos": [
- {
- "enabled": true,
- "severity": "string"
}
], - "sub_category_types": [
- "string"
], - "title": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Modify the specified health check details.
An Health Check instance
cluster_uuid | string |
object (patch.dto.health.check.HealthCheckDTO) health-check | |
operation | string |
curl --request PATCH \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/health_checks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid": "string", "generic_dto": { "affected_entity_types": [ "string" ], "alert_config_exception_groups": [ { "auto_resolve": "ENABLED", "cluster_uuids": [ "string" ], "configurable_parameters": [ { "parameter_boolean_value": true, "parameter_default_boolean_value": true, "parameter_default_long_value": 0, "parameter_default_string_value": "string", "parameter_display_name": "string", "parameter_long_value": 0, "parameter_name": "string", "parameter_string_value": "string", "parameter_unit": "string", "parameter_valid_values": [ "string" ], "severity": "string" } ], "severity_threshold_infos": [ { "enabled": true, "severity": "string" } ] } ], "alert_configurable_parameters": [ { "parameter_boolean_value": true, "parameter_default_boolean_value": true, "parameter_default_long_value": 0, "parameter_default_string_value": "string", "parameter_display_name": "string", "parameter_long_value": 0, "parameter_name": "string", "parameter_string_value": "string", "parameter_unit": "string", "parameter_valid_values": [ "string" ], "severity": "string" } ], "alert_type_id": "string", "applicable_for_multi_cluster": true, "applicable_for_single_cluster": true, "auto_resolve": "ENABLED", "category_types": [ "string" ], "causes": [ "string" ], "check_type": "SCHEDULED", "classifications": [ "string" ], "description": "string", "enabled": true, "exception_count": 0, "id": "string", "impact_types": [ "string" ], "impacts": [ "string" ], "is_global_config": true, "is_user_defined": true, "kb_list": [ "string" ], "message": "string", "metrics": [ { "display_name": "string", "name": "string" } ], "modified_by_username": "string", "modified_time_stamp_in_usecs": 0, "name": "string", "parameters": { "property1": { "display_name": "string", "name": "string", "valid_values_range": [ "string" ], "value": "string" }, "property2": { "display_name": "string", "name": "string", "valid_values_range": [ "string" ], "value": "string" } }, "policy_uuid": "string", "resolutions": [ "string" ], "schedule_interval_in_secs": 0, "scope": "string", "severity_threshold_infos": [ { "enabled": true, "severity": "string" } ], "sub_category_types": [ "string" ], "title": "string" }, "operation": "string" }'
{- "affected_entity_types": [
- "string"
], - "alert_config_exception_groups": [
- {
- "auto_resolve": "ENABLED",
- "cluster_uuids": [
- "string"
], - "configurable_parameters": [
- {
- "parameter_boolean_value": true,
- "parameter_default_boolean_value": true,
- "parameter_default_long_value": 0,
- "parameter_default_string_value": "string",
- "parameter_display_name": "string",
- "parameter_long_value": 0,
- "parameter_name": "string",
- "parameter_string_value": "string",
- "parameter_unit": "string",
- "parameter_valid_values": [
- "string"
], - "severity": "string"
}
], - "severity_threshold_infos": [
- {
- "enabled": true,
- "severity": "string"
}
]
}
], - "alert_configurable_parameters": [
- {
- "parameter_boolean_value": true,
- "parameter_default_boolean_value": true,
- "parameter_default_long_value": 0,
- "parameter_default_string_value": "string",
- "parameter_display_name": "string",
- "parameter_long_value": 0,
- "parameter_name": "string",
- "parameter_string_value": "string",
- "parameter_unit": "string",
- "parameter_valid_values": [
- "string"
], - "severity": "string"
}
], - "alert_type_id": "string",
- "applicable_for_multi_cluster": true,
- "applicable_for_single_cluster": true,
- "auto_resolve": "ENABLED",
- "category_types": [
- "string"
], - "causes": [
- "string"
], - "check_type": "SCHEDULED",
- "classifications": [
- "string"
], - "description": "string",
- "enabled": true,
- "exception_count": 0,
- "id": "string",
- "impact_types": [
- "string"
], - "impacts": [
- "string"
], - "is_global_config": true,
- "is_user_defined": true,
- "kb_list": [
- "string"
], - "message": "string",
- "metrics": [
- {
- "display_name": "string",
- "name": "string"
}
], - "modified_by_username": "string",
- "modified_time_stamp_in_usecs": 0,
- "name": "string",
- "parameters": {
- "property1": {
- "display_name": "string",
- "name": "string",
- "valid_values_range": [
- "string"
], - "value": "string"
}, - "property2": {
- "display_name": "string",
- "name": "string",
- "valid_values_range": [
- "string"
], - "value": "string"
}
}, - "policy_uuid": "string",
- "resolutions": [
- "string"
], - "schedule_interval_in_secs": 0,
- "scope": "string",
- "severity_threshold_infos": [
- {
- "enabled": true,
- "severity": "string"
}
], - "sub_category_types": [
- "string"
], - "title": "string"
}
Update the specified health check details.
An Health Check instance
affected_entity_types | Array of strings |
Array of objects (update.dto.health.check.HealthCheckDTO_AlertConfigExceptionGroup) | |
Array of objects (update.dto.health.check.HealthCheckDTO_AlertConfigParamDTO) | |
alert_type_id | string |
applicable_for_multi_cluster | boolean |
applicable_for_single_cluster | boolean |
auto_resolve | string Enum: "ENABLED" "DISABLED" "NOT_SUPPORTED" |
category_types | Array of strings |
causes | Array of strings |
check_type | string Enum: "SCHEDULED" "NOT_SCHEDULED" "EVENT_DRIVEN" |
classifications | Array of strings |
description | string |
enabled | boolean |
exception_count | integer <int64> |
id | string |
impact_types | Array of strings |
impacts | Array of strings |
is_global_config | boolean |
is_user_defined | boolean |
kb_list | Array of strings |
message | string |
Array of objects (update.dto.health.check.HealthCheckDTO_HealthCheckMetricDTO) | |
modified_by_username | string |
modified_time_stamp_in_usecs | integer <int64> |
name | string |
object | |
policy_uuid | string |
resolutions | Array of strings |
schedule_interval_in_secs | integer <int32> |
scope | string |
Array of objects (update.dto.health.check.HealthCheckDTO_SeverityThresholdInfoDTO) | |
sub_category_types | Array of strings |
title | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/health_checks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "affected_entity_types": [ "string" ], "alert_config_exception_groups": [ { "auto_resolve": "ENABLED", "cluster_uuids": [ "string" ], "configurable_parameters": [ { "parameter_boolean_value": true, "parameter_default_boolean_value": true, "parameter_default_long_value": 0, "parameter_default_string_value": "string", "parameter_display_name": "string", "parameter_long_value": 0, "parameter_name": "string", "parameter_string_value": "string", "parameter_unit": "string", "parameter_valid_values": [ "string" ], "severity": "string" } ], "severity_threshold_infos": [ { "enabled": true, "severity": "string" } ] } ], "alert_configurable_parameters": [ { "parameter_boolean_value": true, "parameter_default_boolean_value": true, "parameter_default_long_value": 0, "parameter_default_string_value": "string", "parameter_display_name": "string", "parameter_long_value": 0, "parameter_name": "string", "parameter_string_value": "string", "parameter_unit": "string", "parameter_valid_values": [ "string" ], "severity": "string" } ], "alert_type_id": "string", "applicable_for_multi_cluster": true, "applicable_for_single_cluster": true, "auto_resolve": "ENABLED", "category_types": [ "string" ], "causes": [ "string" ], "check_type": "SCHEDULED", "classifications": [ "string" ], "description": "string", "enabled": true, "exception_count": 0, "id": "string", "impact_types": [ "string" ], "impacts": [ "string" ], "is_global_config": true, "is_user_defined": true, "kb_list": [ "string" ], "message": "string", "metrics": [ { "display_name": "string", "name": "string" } ], "modified_by_username": "string", "modified_time_stamp_in_usecs": 0, "name": "string", "parameters": { "property1": { "display_name": "string", "name": "string", "valid_values_range": [ "string" ], "value": "string" }, "property2": { "display_name": "string", "name": "string", "valid_values_range": [ "string" ], "value": "string" } }, "policy_uuid": "string", "resolutions": [ "string" ], "schedule_interval_in_secs": 0, "scope": "string", "severity_threshold_infos": [ { "enabled": true, "severity": "string" } ], "sub_category_types": [ "string" ], "title": "string" }'
{- "affected_entity_types": [
- "string"
], - "alert_config_exception_groups": [
- {
- "auto_resolve": "ENABLED",
- "cluster_uuids": [
- "string"
], - "configurable_parameters": [
- {
- "parameter_boolean_value": true,
- "parameter_default_boolean_value": true,
- "parameter_default_long_value": 0,
- "parameter_default_string_value": "string",
- "parameter_display_name": "string",
- "parameter_long_value": 0,
- "parameter_name": "string",
- "parameter_string_value": "string",
- "parameter_unit": "string",
- "parameter_valid_values": [
- "string"
], - "severity": "string"
}
], - "severity_threshold_infos": [
- {
- "enabled": true,
- "severity": "string"
}
]
}
], - "alert_configurable_parameters": [
- {
- "parameter_boolean_value": true,
- "parameter_default_boolean_value": true,
- "parameter_default_long_value": 0,
- "parameter_default_string_value": "string",
- "parameter_display_name": "string",
- "parameter_long_value": 0,
- "parameter_name": "string",
- "parameter_string_value": "string",
- "parameter_unit": "string",
- "parameter_valid_values": [
- "string"
], - "severity": "string"
}
], - "alert_type_id": "string",
- "applicable_for_multi_cluster": true,
- "applicable_for_single_cluster": true,
- "auto_resolve": "ENABLED",
- "category_types": [
- "string"
], - "causes": [
- "string"
], - "check_type": "SCHEDULED",
- "classifications": [
- "string"
], - "description": "string",
- "enabled": true,
- "exception_count": 0,
- "id": "string",
- "impact_types": [
- "string"
], - "impacts": [
- "string"
], - "is_global_config": true,
- "is_user_defined": true,
- "kb_list": [
- "string"
], - "message": "string",
- "metrics": [
- {
- "display_name": "string",
- "name": "string"
}
], - "modified_by_username": "string",
- "modified_time_stamp_in_usecs": 0,
- "name": "string",
- "parameters": {
- "property1": {
- "display_name": "string",
- "name": "string",
- "valid_values_range": [
- "string"
], - "value": "string"
}, - "property2": {
- "display_name": "string",
- "name": "string",
- "valid_values_range": [
- "string"
], - "value": "string"
}
}, - "policy_uuid": "string",
- "resolutions": [
- "string"
], - "schedule_interval_in_secs": 0,
- "scope": "string",
- "severity_threshold_infos": [
- {
- "enabled": true,
- "severity": "string"
}
], - "sub_category_types": [
- "string"
], - "title": "string"
}
uuid required | string |
bypass_space_checks | boolean |
ignore_add_in_progress | boolean |
force | boolean |
bypass_upgrade_check | boolean |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Get a particular GPU for a physical Host.
uuid required | string Uuid of the Host |
gpu_uuid required | string UUID of the Host GPU |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/host_gpus/{gpu_uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "cluster_name": "string",
- "cluster_uuid": "string",
- "gpu_config": {
- "assignable": true,
- "device_id": 0,
- "device_name": "string",
- "fraction": 0,
- "frame_buffer_size_bytes": 0,
- "gpu_mode": "UNUSED",
- "gpu_profile": "string",
- "gpu_type": "PASS_THROUGH_GRAPHICS",
- "gpu_vendor": "NVIDIA",
- "guest_driver_version": "string",
- "in_use": true,
- "licenses": [
- "string"
], - "max_instances_per_vm": 0,
- "max_resolution": "string",
- "num_virtual_display_heads": 0,
- "numa_node": 0,
- "sbdf": "string",
- "vm_uuids": [
- "string"
]
}, - "id": "string",
- "node_id": "string",
- "node_uuid": "string",
- "num_vgpus_allocated": 0,
- "uuid": "string"
}
Get a Physical Host with the specified id.
uuid required | string Uuid of a Physical Host |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "acropolis_connection_state": "string",
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "backplane_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "backplane_ip": "string",
- "bios_model": "string",
- "bios_version": "string",
- "block_location": "string",
- "block_model": "string",
- "block_model_name": "string",
- "block_serial": "string",
- "bmc_model": "string",
- "bmc_version": "string",
- "boot_time_in_usecs": 0,
- "cluster_uuid": "string",
- "controller_vm_backplane_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "controller_vm_backplane_ip": "string",
- "cpu_capacity_in_hz": 0,
- "cpu_frequency_in_hz": 0,
- "cpu_model": "string",
- "default_vhd_container_id": "string",
- "default_vhd_container_uuid": "string",
- "default_vhd_location": "string",
- "default_vhd_storage_container_id": "string",
- "default_vhd_storage_container_uuid": "string",
- "default_vm_container_id": "string",
- "default_vm_container_uuid": "string",
- "default_vm_location": "string",
- "default_vm_storage_container_id": "string",
- "default_vm_storage_container_uuid": "string",
- "disk_hardware_configs": {
- "property1": {
- "background_operation": "string",
- "bad": true,
- "boot_disk": true,
- "can_add_as_new_disk": true,
- "can_add_as_old_disk": true,
- "current_firmware_version": "string",
- "disk_id": "string",
- "disk_uuid": "string",
- "location": 0,
- "model": "string",
- "mount_path": "string",
- "mounted": true,
- "only_boot_disk": true,
- "serial_number": "string",
- "target_firmware_version": "string",
- "under_diagnosis": true,
- "vendor": "string"
}, - "property2": {
- "background_operation": "string",
- "bad": true,
- "boot_disk": true,
- "can_add_as_new_disk": true,
- "can_add_as_old_disk": true,
- "current_firmware_version": "string",
- "disk_id": "string",
- "disk_uuid": "string",
- "location": 0,
- "model": "string",
- "mount_path": "string",
- "mounted": true,
- "only_boot_disk": true,
- "serial_number": "string",
- "target_firmware_version": "string",
- "under_diagnosis": true,
- "vendor": "string"
}
}, - "dynamic_ring_changing_node": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "failover_cluster_fqdn": "string",
- "failover_cluster_node_state": "string",
- "gpu_driver_version": "string",
- "has_csr": true,
- "hba_firmwares_list": [
- {
- "hba_model": "string",
- "hba_version": "string"
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "host_gpus": [
- "string"
], - "host_in_maintenance_mode": true,
- "host_maintenance_mode_reason": "string",
- "host_nic_ids": [
- "string"
], - "host_type": "HYPER_CONVERGED",
- "hypervisor_address": "string",
- "hypervisor_address_value": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "hypervisor_full_name": "string",
- "hypervisor_key": "string",
- "hypervisor_password": "string",
- "hypervisor_state": "string",
- "hypervisor_type": "string",
- "hypervisor_username": "string",
- "ipmi_address": "string",
- "ipmi_address_value": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "ipmi_password": "string",
- "ipmi_username": "string",
- "is_degraded": true,
- "is_hardware_virtualized": true,
- "is_secure_booted": true,
- "key_management_device_to_certificate_status": {
- "property1": true,
- "property2": true
}, - "management_server_name": "string",
- "memory_capacity_in_bytes": 0,
- "metadata_store_status": "string",
- "metadata_store_status_message": "string",
- "monitored": true,
- "name": "string",
- "num_cpu_cores": 0,
- "num_cpu_sockets": 0,
- "num_cpu_threads": 0,
- "num_vms": 0,
- "oplog_disk_pct": 0.1,
- "oplog_disk_size": 0,
- "position": {
- "name": "string",
- "ordinal": 0,
- "physical_position": "C"
}, - "rdma_backplane_address_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "rdma_backplane_ips": [
- "string"
], - "reboot_pending": true,
- "removal_status": [
- "NA"
], - "serial": "string",
- "service_vmexternal_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "service_vmexternal_ip": "string",
- "service_vmid": "string",
- "service_vmnat_ip": "string",
- "service_vmnat_port": 0,
- "state": "NEW",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vzone_name": "string"
}
Get stats for a particular GPU for a physical Host.
uuid required | string Uuid of the Host |
gpu_uuid required | string UUID of the Host GPU |
metrics required | Array of strings List of metrics |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
interval_in_secs | integer <int32> Sampling interval of stats |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/host_gpus/{gpu_uuid}/stats \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "stats_specific_responses": [
- {
- "interval_in_secs": 0,
- "message": "string",
- "metric": "string",
- "start_time_in_usecs": 0,
- "successful": true,
- "values": [
- 0
]
}
]
}
uuid required | string Uuid of a Host |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
uuid required | string Uuid of a Host |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of GPUs for a physical Host.
uuid required | string Uuid of the Host |
count | integer <int32> Number of host GPUs to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
search_string | string Search string |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/host_gpus \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "cluster_name": "string",
- "cluster_uuid": "string",
- "gpu_config": {
- "assignable": true,
- "device_id": 0,
- "device_name": "string",
- "fraction": 0,
- "frame_buffer_size_bytes": 0,
- "gpu_mode": "UNUSED",
- "gpu_profile": "string",
- "gpu_type": "PASS_THROUGH_GRAPHICS",
- "gpu_vendor": "NVIDIA",
- "guest_driver_version": "string",
- "in_use": true,
- "licenses": [
- "string"
], - "max_instances_per_vm": 0,
- "max_resolution": "string",
- "num_virtual_display_heads": 0,
- "numa_node": 0,
- "sbdf": "string",
- "vm_uuids": [
- "string"
]
}, - "id": "string",
- "node_id": "string",
- "node_uuid": "string",
- "num_vgpus_allocated": 0,
- "uuid": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of GPUs for all physical Host.
count | integer <int32> Number of host GPUs to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
search_string | string Search string |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/host_gpus \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "cluster_name": "string",
- "cluster_uuid": "string",
- "gpu_config": {
- "assignable": true,
- "device_id": 0,
- "device_name": "string",
- "fraction": 0,
- "frame_buffer_size_bytes": 0,
- "gpu_mode": "UNUSED",
- "gpu_profile": "string",
- "gpu_type": "PASS_THROUGH_GRAPHICS",
- "gpu_vendor": "NVIDIA",
- "guest_driver_version": "string",
- "in_use": true,
- "licenses": [
- "string"
], - "max_instances_per_vm": 0,
- "max_resolution": "string",
- "num_virtual_display_heads": 0,
- "numa_node": 0,
- "sbdf": "string",
- "vm_uuids": [
- "string"
]
}, - "id": "string",
- "node_id": "string",
- "node_uuid": "string",
- "num_vgpus_allocated": 0,
- "uuid": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of Physical Hosts configured in the cluster.
count | integer <int32> Number of Physical Hosts to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
search_string | string Search string |
search_attribute_list | Array of strings Search attribute list |
page | integer <int32> Page number |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acropolis_connection_state": "string",
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "backplane_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "backplane_ip": "string",
- "bios_model": "string",
- "bios_version": "string",
- "block_location": "string",
- "block_model": "string",
- "block_model_name": "string",
- "block_serial": "string",
- "bmc_model": "string",
- "bmc_version": "string",
- "boot_time_in_usecs": 0,
- "cluster_uuid": "string",
- "controller_vm_backplane_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "controller_vm_backplane_ip": "string",
- "cpu_capacity_in_hz": 0,
- "cpu_frequency_in_hz": 0,
- "cpu_model": "string",
- "default_vhd_container_id": "string",
- "default_vhd_container_uuid": "string",
- "default_vhd_location": "string",
- "default_vhd_storage_container_id": "string",
- "default_vhd_storage_container_uuid": "string",
- "default_vm_container_id": "string",
- "default_vm_container_uuid": "string",
- "default_vm_location": "string",
- "default_vm_storage_container_id": "string",
- "default_vm_storage_container_uuid": "string",
- "disk_hardware_configs": {
- "property1": {
- "background_operation": "string",
- "bad": true,
- "boot_disk": true,
- "can_add_as_new_disk": true,
- "can_add_as_old_disk": true,
- "current_firmware_version": "string",
- "disk_id": "string",
- "disk_uuid": "string",
- "location": 0,
- "model": "string",
- "mount_path": "string",
- "mounted": true,
- "only_boot_disk": true,
- "serial_number": "string",
- "target_firmware_version": "string",
- "under_diagnosis": true,
- "vendor": "string"
}, - "property2": {
- "background_operation": "string",
- "bad": true,
- "boot_disk": true,
- "can_add_as_new_disk": true,
- "can_add_as_old_disk": true,
- "current_firmware_version": "string",
- "disk_id": "string",
- "disk_uuid": "string",
- "location": 0,
- "model": "string",
- "mount_path": "string",
- "mounted": true,
- "only_boot_disk": true,
- "serial_number": "string",
- "target_firmware_version": "string",
- "under_diagnosis": true,
- "vendor": "string"
}
}, - "dynamic_ring_changing_node": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "failover_cluster_fqdn": "string",
- "failover_cluster_node_state": "string",
- "gpu_driver_version": "string",
- "has_csr": true,
- "hba_firmwares_list": [
- {
- "hba_model": "string",
- "hba_version": "string"
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "host_gpus": [
- "string"
], - "host_in_maintenance_mode": true,
- "host_maintenance_mode_reason": "string",
- "host_nic_ids": [
- "string"
], - "host_type": "HYPER_CONVERGED",
- "hypervisor_address": "string",
- "hypervisor_address_value": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "hypervisor_full_name": "string",
- "hypervisor_key": "string",
- "hypervisor_password": "string",
- "hypervisor_state": "string",
- "hypervisor_type": "string",
- "hypervisor_username": "string",
- "ipmi_address": "string",
- "ipmi_address_value": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "ipmi_password": "string",
- "ipmi_username": "string",
- "is_degraded": true,
- "is_hardware_virtualized": true,
- "is_secure_booted": true,
- "key_management_device_to_certificate_status": {
- "property1": true,
- "property2": true
}, - "management_server_name": "string",
- "memory_capacity_in_bytes": 0,
- "metadata_store_status": "string",
- "metadata_store_status_message": "string",
- "monitored": true,
- "name": "string",
- "num_cpu_cores": 0,
- "num_cpu_sockets": 0,
- "num_cpu_threads": 0,
- "num_vms": 0,
- "oplog_disk_pct": 0.1,
- "oplog_disk_size": 0,
- "position": {
- "name": "string",
- "ordinal": 0,
- "physical_position": "C"
}, - "rdma_backplane_address_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "rdma_backplane_ips": [
- "string"
], - "reboot_pending": true,
- "removal_status": [
- "NA"
], - "serial": "string",
- "service_vmexternal_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "service_vmexternal_ip": "string",
- "service_vmid": "string",
- "service_vmnat_ip": "string",
- "service_vmnat_port": 0,
- "state": "NEW",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vzone_name": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of virtual GPU profiles for all physical Hosts.
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/gpu_profiles \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "allocated_vm_uuids": [
- "string"
], - "gpu_config": {
- "assignable": true,
- "device_id": 0,
- "device_name": "string",
- "fraction": 0,
- "frame_buffer_size_bytes": 0,
- "gpu_mode": "UNUSED",
- "gpu_profile": "string",
- "gpu_type": "PASS_THROUGH_GRAPHICS",
- "gpu_vendor": "NVIDIA",
- "guest_driver_version": "string",
- "in_use": true,
- "licenses": [
- "string"
], - "max_instances_per_vm": 0,
- "max_resolution": "string",
- "num_virtual_display_heads": 0,
- "numa_node": 0,
- "sbdf": "string",
- "vm_uuids": [
- "string"
]
}
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
If start time and end time are included in the query string, then historical stats are retrieved. Otherwise, the latest stats are retrieved.
uuid required | string Uuid of a Physical Host |
metrics required | Array of strings List of metrics |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
interval_in_secs | integer <int32> Sampling interval of stats |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/stats \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "stats_specific_responses": [
- {
- "interval_in_secs": 0,
- "message": "string",
- "metric": "string",
- "start_time_in_usecs": 0,
- "successful": true,
- "values": [
- 0
]
}
]
}
uuid required | string Uuid of the Host |
pnic_id required | string ID of Host Nic |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/host_nics/{pnic_id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "attached_switch_interface_map": {
- "property1": [
- {
- "attached_host_id": "string",
- "attached_host_nic_ids": [
- "string"
], - "attached_host_nic_uuids": [
- "string"
], - "attached_host_uuid": "string",
- "description": "string",
- "id": "string",
- "index": 0,
- "last_change_time": "string",
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "port_num": "string",
- "speed_in_kbps": 0,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "switch_id": "string",
- "switch_management_address": "string",
- "switch_uuid": "string",
- "type": "string",
- "uuid": "string"
}
], - "property2": [
- {
- "attached_host_id": "string",
- "attached_host_nic_ids": [
- "string"
], - "attached_host_nic_uuids": [
- "string"
], - "attached_host_uuid": "string",
- "description": "string",
- "id": "string",
- "index": 0,
- "last_change_time": "string",
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "port_num": "string",
- "speed_in_kbps": 0,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "switch_id": "string",
- "switch_management_address": "string",
- "switch_uuid": "string",
- "type": "string",
- "uuid": "string"
}
]
}, - "description": "string",
- "dhcp_enabled": true,
- "discovery_protocol": "string",
- "host_id": "string",
- "id": "string",
- "ipv4_addresses": [
- "string"
], - "ipv6_addresses": [
- "string"
], - "link_speed_in_kbps": 0,
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "node_uuid": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "string",
- "switch_device_id": "string",
- "switch_mac_address": "string",
- "switch_management_ip": "string",
- "switch_port_id": "string",
- "switch_vendor_info": "string",
- "switch_vlan_id": "string",
- "uuid": "string"
}
uuid required | string Uuid of the Host |
pnic_id required | string ID of the Host Nic |
metrics required | Array of strings List of metrics |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
interval_in_secs | integer <int32> Sampling interval of stats |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/host_nics/{pnic_id}/stats \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "stats_specific_responses": [
- {
- "interval_in_secs": 0,
- "message": "string",
- "metric": "string",
- "start_time_in_usecs": 0,
- "successful": true,
- "values": [
- 0
]
}
]
}
uuid required | string Uuid of the Host |
pnic_id | string ID of Host Nic |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/host_nics \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "attached_switch_interface_map": {
- "property1": [
- {
- "attached_host_id": "string",
- "attached_host_nic_ids": [
- "string"
], - "attached_host_nic_uuids": [
- "string"
], - "attached_host_uuid": "string",
- "description": "string",
- "id": "string",
- "index": 0,
- "last_change_time": "string",
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "port_num": "string",
- "speed_in_kbps": 0,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "switch_id": "string",
- "switch_management_address": "string",
- "switch_uuid": "string",
- "type": "string",
- "uuid": "string"
}
], - "property2": [
- {
- "attached_host_id": "string",
- "attached_host_nic_ids": [
- "string"
], - "attached_host_nic_uuids": [
- "string"
], - "attached_host_uuid": "string",
- "description": "string",
- "id": "string",
- "index": 0,
- "last_change_time": "string",
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "port_num": "string",
- "speed_in_kbps": 0,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "switch_id": "string",
- "switch_management_address": "string",
- "switch_uuid": "string",
- "type": "string",
- "uuid": "string"
}
]
}, - "description": "string",
- "dhcp_enabled": true,
- "discovery_protocol": "string",
- "host_id": "string",
- "id": "string",
- "ipv4_addresses": [
- "string"
], - "ipv6_addresses": [
- "string"
], - "link_speed_in_kbps": 0,
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "node_uuid": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "string",
- "switch_device_id": "string",
- "switch_mac_address": "string",
- "switch_management_ip": "string",
- "switch_port_id": "string",
- "switch_vendor_info": "string",
- "switch_vlan_id": "string",
- "uuid": "string"
}
]
uuid required | string Uuid of the Host |
vnic_id required | string ID of Host Virtual Nic |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/virtual_nics/{vnic_id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "description": "string",
- "dhcp_enabled": true,
- "host_id": "string",
- "host_nics": [
- {
- "attached_switch_interface_map": {
- "property1": [
- {
- "attached_host_id": "string",
- "attached_host_nic_ids": [
- "string"
], - "attached_host_nic_uuids": [
- "string"
], - "attached_host_uuid": "string",
- "description": "string",
- "id": "string",
- "index": 0,
- "last_change_time": "string",
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "port_num": "string",
- "speed_in_kbps": 0,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "switch_id": "string",
- "switch_management_address": "string",
- "switch_uuid": "string",
- "type": "string",
- "uuid": "string"
}
], - "property2": [
- {
- "attached_host_id": "string",
- "attached_host_nic_ids": [
- "string"
], - "attached_host_nic_uuids": [
- "string"
], - "attached_host_uuid": "string",
- "description": "string",
- "id": "string",
- "index": 0,
- "last_change_time": "string",
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "port_num": "string",
- "speed_in_kbps": 0,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "switch_id": "string",
- "switch_management_address": "string",
- "switch_uuid": "string",
- "type": "string",
- "uuid": "string"
}
]
}, - "description": "string",
- "dhcp_enabled": true,
- "discovery_protocol": "string",
- "host_id": "string",
- "id": "string",
- "ipv4_addresses": [
- "string"
], - "ipv6_addresses": [
- "string"
], - "link_speed_in_kbps": 0,
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "node_uuid": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "string",
- "switch_device_id": "string",
- "switch_mac_address": "string",
- "switch_management_ip": "string",
- "switch_port_id": "string",
- "switch_vendor_info": "string",
- "switch_vlan_id": "string",
- "uuid": "string"
}
], - "id": "string",
- "ipv4_addresses": [
- "string"
], - "ipv6_addresses": [
- "string"
], - "link_speed_in_kbps": 0,
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "node_uuid": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "string",
- "uuid": "string",
- "vlan_id": 0
}
uuid required | string Uuid of the Host |
vnic_id required | string ID of the Host Virtual Nic |
metrics required | Array of strings List of metrics |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
interval_in_secs | integer <int32> Sampling interval of stats |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/virtual_nics/{vnic_id}/stats \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "stats_specific_responses": [
- {
- "interval_in_secs": 0,
- "message": "string",
- "metric": "string",
- "start_time_in_usecs": 0,
- "successful": true,
- "values": [
- 0
]
}
]
}
uuid required | string Uuid of the Host |
vnic_id | string ID of Host Virtual Nic |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/virtual_nics \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "description": "string",
- "dhcp_enabled": true,
- "host_id": "string",
- "host_nics": [
- {
- "attached_switch_interface_map": {
- "property1": [
- {
- "attached_host_id": "string",
- "attached_host_nic_ids": [
- "string"
], - "attached_host_nic_uuids": [
- "string"
], - "attached_host_uuid": "string",
- "description": "string",
- "id": "string",
- "index": 0,
- "last_change_time": "string",
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "port_num": "string",
- "speed_in_kbps": 0,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "switch_id": "string",
- "switch_management_address": "string",
- "switch_uuid": "string",
- "type": "string",
- "uuid": "string"
}
], - "property2": [
- {
- "attached_host_id": "string",
- "attached_host_nic_ids": [
- "string"
], - "attached_host_nic_uuids": [
- "string"
], - "attached_host_uuid": "string",
- "description": "string",
- "id": "string",
- "index": 0,
- "last_change_time": "string",
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "port_num": "string",
- "speed_in_kbps": 0,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "switch_id": "string",
- "switch_management_address": "string",
- "switch_uuid": "string",
- "type": "string",
- "uuid": "string"
}
]
}, - "description": "string",
- "dhcp_enabled": true,
- "discovery_protocol": "string",
- "host_id": "string",
- "id": "string",
- "ipv4_addresses": [
- "string"
], - "ipv6_addresses": [
- "string"
], - "link_speed_in_kbps": 0,
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "node_uuid": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "string",
- "switch_device_id": "string",
- "switch_mac_address": "string",
- "switch_management_ip": "string",
- "switch_port_id": "string",
- "switch_vendor_info": "string",
- "switch_vlan_id": "string",
- "uuid": "string"
}
], - "id": "string",
- "ipv4_addresses": [
- "string"
], - "ipv6_addresses": [
- "string"
], - "link_speed_in_kbps": 0,
- "mac_address": "string",
- "mtu_in_bytes": 0,
- "name": "string",
- "node_uuid": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "string",
- "uuid": "string",
- "vlan_id": 0
}
]
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/failover_cluster \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "credential": {
- "logon_name": "string",
- "password": "string"
}, - "ip_address": "string",
- "member_nodes": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "name": "string",
- "node_to_remove": "string",
- "node_uuid_to_remove": "string",
- "node_uuids_to_add": [
- "string"
], - "nodes_to_add": [
- "string"
]
}
]
uuid required | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/detach_node_from_metadata_store \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
uuid required | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/enable_metadata_store \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
uuid required | string |
value | boolean |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/enable_monitoring \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": true }'
{- "value": true
}
object (create.dto.hyperv.CredentialDTO) | |
ip_address | string |
Array of objects (create.dto.appliance.configuration.NodeDTO) | |
name | string |
node_to_remove | string |
node_uuid_to_remove | string |
node_uuids_to_add | Array of strings |
nodes_to_add | Array of strings |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/failover_cluster \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "credential": { "logon_name": "string", "password": "string" }, "ip_address": "string", "member_nodes": [ { "acropolis_connection_state": "string", "alert_summary": { "alert_summaries": { "property1": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "property2": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } } }, "count": 0 }, "backplane_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "backplane_ip": "string", "bios_model": "string", "bios_version": "string", "block_location": "string", "block_model": "string", "block_model_name": "string", "block_serial": "string", "bmc_model": "string", "bmc_version": "string", "boot_time_in_usecs": 0, "cluster_uuid": "string", "controller_vm_backplane_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "controller_vm_backplane_ip": "string", "cpu_capacity_in_hz": 0, "cpu_frequency_in_hz": 0, "cpu_model": "string", "default_vhd_container_id": "string", "default_vhd_container_uuid": "string", "default_vhd_location": "string", "default_vhd_storage_container_id": "string", "default_vhd_storage_container_uuid": "string", "default_vm_container_id": "string", "default_vm_container_uuid": "string", "default_vm_location": "string", "default_vm_storage_container_id": "string", "default_vm_storage_container_uuid": "string", "disk_hardware_configs": { "property1": { "background_operation": "string", "bad": true, "boot_disk": true, "can_add_as_new_disk": true, "can_add_as_old_disk": true, "current_firmware_version": "string", "disk_id": "string", "disk_uuid": "string", "location": 0, "model": "string", "mount_path": "string", "mounted": true, "only_boot_disk": true, "serial_number": "string", "target_firmware_version": "string", "under_diagnosis": true, "vendor": "string" }, "property2": { "background_operation": "string", "bad": true, "boot_disk": true, "can_add_as_new_disk": true, "can_add_as_old_disk": true, "current_firmware_version": "string", "disk_id": "string", "disk_uuid": "string", "location": 0, "model": "string", "mount_path": "string", "mounted": true, "only_boot_disk": true, "serial_number": "string", "target_firmware_version": "string", "under_diagnosis": true, "vendor": "string" } }, "dynamic_ring_changing_node": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "failover_cluster_fqdn": "string", "failover_cluster_node_state": "string", "gpu_driver_version": "string", "has_csr": true, "hba_firmwares_list": [ { "hba_model": "string", "hba_version": "string" } ], "health_summary": { "entity_type_summaries": [ { "checks_in_error": { "property1": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] }, "property2": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] } }, "detailed_check_summary": { "property1": {}, "property2": {} }, "entity_type": "PAGE", "filter_criteria": "string", "health_summary": { "property1": 0, "property2": 0 } } ], "health_check_summaries": { "property1": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 }, "property2": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 } }, "health_status": "Critical" }, "host_gpus": [ "string" ], "host_in_maintenance_mode": true, "host_maintenance_mode_reason": "string", "host_nic_ids": [ "string" ], "host_type": "HYPER_CONVERGED", "hypervisor_address": "string", "hypervisor_address_value": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "hypervisor_full_name": "string", "hypervisor_key": "string", "hypervisor_password": "string", "hypervisor_state": "string", "hypervisor_type": "string", "hypervisor_username": "string", "ipmi_address": "string", "ipmi_address_value": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "ipmi_password": "string", "ipmi_username": "string", "is_degraded": true, "is_hardware_virtualized": true, "is_secure_booted": true, "key_management_device_to_certificate_status": { "property1": true, "property2": true }, "management_server_name": "string", "memory_capacity_in_bytes": 0, "metadata_store_status": "string", "metadata_store_status_message": "string", "monitored": true, "name": "string", "num_cpu_cores": 0, "num_cpu_sockets": 0, "num_cpu_threads": 0, "num_vms": 0, "oplog_disk_pct": null, "oplog_disk_size": 0, "position": { "name": "string", "ordinal": 0, "physical_position": "C" }, "rdma_backplane_address_list": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "rdma_backplane_ips": [ "string" ], "reboot_pending": true, "removal_status": [ "string" ], "serial": "string", "service_vmexternal_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "service_vmexternal_ip": "string", "service_vmid": "string", "service_vmnat_ip": "string", "service_vmnat_port": 0, "state": "NEW", "stats": { "property1": "string", "property2": "string" }, "usage_stats": { "property1": "string", "property2": "string" }, "uuid": "string", "vzone_name": "string" } ], "name": "string", "node_to_remove": "string", "node_uuid_to_remove": "string", "node_uuids_to_add": [ "string" ], "nodes_to_add": [ "string" ] }'
{- "node_specific_status": [
- {
- "message": "string",
- "node_id": "string",
- "node_uuid": "string",
- "reboot_initiated": true,
- "successful": true
}
]
}
object (create.dto.hyperv.CredentialDTO) | |
object (create.dto.hyperv.DomainDescriptorDTO) | |
force | boolean |
Array of objects (create.dto.hyperv.HypervNodeDescriptorDTO) | |
node_name_prefix | string |
restart | boolean |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/join_domain \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "credential": { "logon_name": "string", "password": "string" }, "domain_descriptor": { "domain_name": "string", "name_prefix": "string", "name_server": "string", "ou_path": "string" }, "force": true, "node_descriptors": [ { "name": "string", "node_id": "string", "node_uuid": "string" } ], "node_name_prefix": "string", "restart": true }'
{- "node_specific_status": [
- {
- "message": "string",
- "node_id": "string",
- "node_uuid": "string",
- "reboot_initiated": true,
- "successful": true
}
]
}
delay_secs | integer <int32> |
node_ids | Array of strings |
node_uuids | Array of strings |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/restart \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "delay_secs": 0, "node_ids": [ "string" ], "node_uuids": [ "string" ] }'
{- "node_specific_status": [
- {
- "message": "string",
- "node_id": "string",
- "node_uuid": "string",
- "reboot_initiated": true,
- "successful": true
}
]
}
container_for_vhd_files | string |
container_for_vm_config_files | string |
node_ids | Array of strings |
node_uuids | Array of strings |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/set_default_vm_vhd_location \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "container_for_vhd_files": "string", "container_for_vm_config_files": "string", "node_ids": [ "string" ], "node_uuids": [ "string" ] }'
{- "node_specific_status": [
- {
- "message": "string",
- "node_id": "string",
- "node_uuid": "string",
- "reboot_initiated": true,
- "successful": true
}
]
}
object (create.dto.hyperv.CredentialDTO) | |
object (create.dto.hyperv.DomainDescriptorDTO) | |
force | boolean |
Array of objects (create.dto.hyperv.HypervNodeDescriptorDTO) | |
node_name_prefix | string |
restart | boolean |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/unjoin_domain \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "credential": { "logon_name": "string", "password": "string" }, "domain_descriptor": { "domain_name": "string", "name_prefix": "string", "name_server": "string", "ou_path": "string" }, "force": true, "node_descriptors": [ { "name": "string", "node_id": "string", "node_uuid": "string" } ], "node_name_prefix": "string", "restart": true }'
{- "node_specific_status": [
- {
- "message": "string",
- "node_id": "string",
- "node_uuid": "string",
- "reboot_initiated": true,
- "successful": true
}
]
}
Pull a host out of maintenance mode or abort a prior attempt to enter maintenance mode even if the attempt is ongoing. This is a synchronous idempotent operation. If the host is no longer in maintenance mode, this command has no effect. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the host logical timestamp. The logical timestamp can be obtained from the host object.
uuid required | string UUID of host to pull out of maintenance mode |
Logical timestamp associated with host object
logical_timestamp | integer <int64> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/exit_maintenance_mode \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "logical_timestamp": 0 }'
{- "value": true
}
Put a host in maintenance mode. It can be specified if Virtual Machines currently running on the host need to be powered off, live migrated or cold migrated. The host will be marked as unschedulable, so that no new Virtual Machines can be instantiated on it. Subsequently, an attempt is made to evacuate VMs from the host. If the evacuation attempt fails (e.g., because there are insufficient resources available elsewhere in the cluster), the host will remain in the entering maintenance mode state, where it is marked unschedulable, waiting for user remediation. This operation is idempotent and can be run again with different options like powering off the Virtual Machines, live or cold migrating them. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
uuid required | string UUID of host to put in maintenance mode |
Maintenance mode options
evacuation_option | string Enum: "POWER_OFF" "COLD_MIGRATE" "LIVE_MIGRATE" |
logical_timestamp | integer <int64> |
non_migratable_vm_option | string Enum: "BLOCK" "ACPI_SHUTDOWN_AND_POWER_OFF" |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts/{uuid}/enter_maintenance_mode \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "evacuation_option": "POWER_OFF", "logical_timestamp": 0, "non_migratable_vm_option": "BLOCK" }'
{- "task_uuid": "string"
}
acropolis_connection_state | string |
object (update.dto.alerts.AlertSummaryDTO) | |
Array of objects (update.common.Address) | |
backplane_ip | string |
bios_model | string |
bios_version | string |
block_location | string |
block_model | string |
block_model_name | string |
block_serial | string |
bmc_model | string |
bmc_version | string |
boot_time_in_usecs | integer <int64> |
cluster_uuid | string |
Array of objects (update.common.Address) | |
controller_vm_backplane_ip | string |
cpu_capacity_in_hz | integer <int64> |
cpu_frequency_in_hz | integer <int64> |
cpu_model | string |
default_vhd_container_id | string |
default_vhd_container_uuid | string |
default_vhd_location | string |
default_vhd_storage_container_id | string |
default_vhd_storage_container_uuid | string |
default_vm_container_id | string |
default_vm_container_uuid | string |
default_vm_location | string |
default_vm_storage_container_id | string |
default_vm_storage_container_uuid | string |
object | |
dynamic_ring_changing_node | string (circular.reference.handler) Default: "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." |
failover_cluster_fqdn | string |
failover_cluster_node_state | string |
gpu_driver_version | string |
has_csr | boolean |
Array of objects (update.dto.appliance.configuration.NodeDTO_HbaFirmware) | |
object (update.dto.health.check.HealthSummaryDTO) | |
host_gpus | Array of strings |
host_in_maintenance_mode | boolean |
host_maintenance_mode_reason | string |
host_nic_ids | Array of strings |
host_type | string Enum: "HYPER_CONVERGED" "COMPUTE_ONLY" |
hypervisor_address | string |
Array of objects (update.common.Address) | |
hypervisor_full_name | string |
hypervisor_key | string |
hypervisor_password | string |
hypervisor_state | string |
hypervisor_type | string |
hypervisor_username | string |
ipmi_address | string |
Array of objects (update.common.Address) | |
ipmi_password | string |
ipmi_username | string |
is_degraded | boolean |
is_hardware_virtualized | boolean |
is_secure_booted | boolean |
object | |
management_server_name | string |
memory_capacity_in_bytes | integer <int64> |
metadata_store_status | string |
metadata_store_status_message | string |
monitored | boolean |
name | string |
num_cpu_cores | integer <int64> |
num_cpu_sockets | integer <int64> |
num_cpu_threads | integer <int64> |
num_vms | integer <int64> |
oplog_disk_pct | number <float> |
oplog_disk_size | integer <int64> |
object (update.dto.appliance.configuration.NodePositionDTO) | |
Array of objects (update.common.Address) | |
rdma_backplane_ips | Array of strings |
reboot_pending | boolean |
removal_status | Array of strings Items Enum: "NA" "AWAITING_CONFIG_DATA_MIGRATION" "AWAITING_DATA_MIGRATION" "AWAITING_HOST_EVACUATION" "AWAITING_CLUSTER_RESTART" "AWAITING_MASTER_KEY_MIGRATION" |
serial | string |
Array of objects (update.common.Address) | |
service_vmexternal_ip | string |
service_vmid | string |
service_vmnat_ip | string |
service_vmnat_port | integer <int32> |
state | string Enum: "NEW" "NORMAL" "MARKED_FOR_REMOVAL_BUT_NOT_DETACHABLE" "DETACHABLE" |
object | |
object | |
uuid | string |
vzone_name | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/hosts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "acropolis_connection_state": "string", "alert_summary": { "alert_summaries": { "property1": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "property2": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } } }, "count": 0 }, "backplane_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "backplane_ip": "string", "bios_model": "string", "bios_version": "string", "block_location": "string", "block_model": "string", "block_model_name": "string", "block_serial": "string", "bmc_model": "string", "bmc_version": "string", "boot_time_in_usecs": 0, "cluster_uuid": "string", "controller_vm_backplane_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "controller_vm_backplane_ip": "string", "cpu_capacity_in_hz": 0, "cpu_frequency_in_hz": 0, "cpu_model": "string", "default_vhd_container_id": "string", "default_vhd_container_uuid": "string", "default_vhd_location": "string", "default_vhd_storage_container_id": "string", "default_vhd_storage_container_uuid": "string", "default_vm_container_id": "string", "default_vm_container_uuid": "string", "default_vm_location": "string", "default_vm_storage_container_id": "string", "default_vm_storage_container_uuid": "string", "disk_hardware_configs": { "property1": { "background_operation": "string", "bad": true, "boot_disk": true, "can_add_as_new_disk": true, "can_add_as_old_disk": true, "current_firmware_version": "string", "disk_id": "string", "disk_uuid": "string", "location": 0, "model": "string", "mount_path": "string", "mounted": true, "only_boot_disk": true, "serial_number": "string", "target_firmware_version": "string", "under_diagnosis": true, "vendor": "string" }, "property2": { "background_operation": "string", "bad": true, "boot_disk": true, "can_add_as_new_disk": true, "can_add_as_old_disk": true, "current_firmware_version": "string", "disk_id": "string", "disk_uuid": "string", "location": 0, "model": "string", "mount_path": "string", "mounted": true, "only_boot_disk": true, "serial_number": "string", "target_firmware_version": "string", "under_diagnosis": true, "vendor": "string" } }, "dynamic_ring_changing_node": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "failover_cluster_fqdn": "string", "failover_cluster_node_state": "string", "gpu_driver_version": "string", "has_csr": true, "hba_firmwares_list": [ { "hba_model": "string", "hba_version": "string" } ], "health_summary": { "entity_type_summaries": [ { "checks_in_error": { "property1": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] }, "property2": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] } }, "detailed_check_summary": { "property1": {}, "property2": {} }, "entity_type": "PAGE", "filter_criteria": "string", "health_summary": { "property1": 0, "property2": 0 } } ], "health_check_summaries": { "property1": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 }, "property2": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 } }, "health_status": "Critical" }, "host_gpus": [ "string" ], "host_in_maintenance_mode": true, "host_maintenance_mode_reason": "string", "host_nic_ids": [ "string" ], "host_type": "HYPER_CONVERGED", "hypervisor_address": "string", "hypervisor_address_value": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "hypervisor_full_name": "string", "hypervisor_key": "string", "hypervisor_password": "string", "hypervisor_state": "string", "hypervisor_type": "string", "hypervisor_username": "string", "ipmi_address": "string", "ipmi_address_value": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "ipmi_password": "string", "ipmi_username": "string", "is_degraded": true, "is_hardware_virtualized": true, "is_secure_booted": true, "key_management_device_to_certificate_status": { "property1": true, "property2": true }, "management_server_name": "string", "memory_capacity_in_bytes": 0, "metadata_store_status": "string", "metadata_store_status_message": "string", "monitored": true, "name": "string", "num_cpu_cores": 0, "num_cpu_sockets": 0, "num_cpu_threads": 0, "num_vms": 0, "oplog_disk_pct": null, "oplog_disk_size": 0, "position": { "name": "string", "ordinal": 0, "physical_position": "C" }, "rdma_backplane_address_list": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "rdma_backplane_ips": [ "string" ], "reboot_pending": true, "removal_status": [ "string" ], "serial": "string", "service_vmexternal_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "service_vmexternal_ip": "string", "service_vmid": "string", "service_vmnat_ip": "string", "service_vmnat_port": 0, "state": "NEW", "stats": { "property1": "string", "property2": "string" }, "usage_stats": { "property1": "string", "property2": "string" }, "uuid": "string", "vzone_name": "string" }'
{- "value": true
}
Add an HTTP Proxy to the cluster.
An HTTP Proxy instance
address | string |
object (create.common.Address) | |
name | string |
password | string |
port | integer <int32> [ 0 .. 65536 ] |
proxy_types | Array of strings Items Enum: "HTTP" "HTTPS" "SOCKS" |
username | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/http_proxies \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "address": "string", "address_value": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "name": "string", "password": "string", "port": 0, "proxy_types": [ "string" ], "username": "string" }'
{- "value": true
}
Delete an HTTP Proxy with the specified name.
name required | string Name of an HTTP Proxy |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/http_proxies/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Get an HTTP Proxy with the specified name.
name required | string Name of an HTTP Proxy |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/http_proxies/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "address": "string",
- "address_value": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "name": "string",
- "password": "string",
- "port": 65536,
- "proxy_types": [
- "HTTP"
], - "username": "string"
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/http_proxies \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "address": "string",
- "address_value": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "name": "string",
- "password": "string",
- "port": 65536,
- "proxy_types": [
- "HTTP"
], - "username": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Modify the specified HTTP Proxy.
An HTTP Proxy instance
cluster_uuid | string |
object (patch.dto.appliance.configuration.HttpProxyDTO) http-proxy | |
operation | string |
curl --request PATCH \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/http_proxies \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid": "string", "generic_dto": { "address": "string", "address_value": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "name": "string", "password": "string", "port": 0, "proxy_types": [ "string" ], "username": "string" }, "operation": "string" }'
{- "value": true
}
Update the specified HTTP Proxy.
An HTTP Proxy instance
address | string |
object (update.common.Address) | |
name | string |
password | string |
port | integer <int32> [ 0 .. 65536 ] |
proxy_types | Array of strings Items Enum: "HTTP" "HTTPS" "SOCKS" |
username | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/http_proxies \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "address": "string", "address_value": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "name": "string", "password": "string", "port": 0, "proxy_types": [ "string" ], "username": "string" }'
{- "value": true
}
Create a Image with specified configuration. There are two modes of creation, one mode you either provide some source (URL, vmdisk, or uploaded file) or you just create the metadata for the image. If a UUID is specified for the Image, this operation will be idempotent. This is an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
Image Creation Specs
annotation | string |
object (create.dto.acropolis.ImageImportSpecDTO) | |
image_type | string Enum: "DISK_IMAGE" "ISO_IMAGE" |
logical_timestamp | integer <int64> |
name | string |
uuid | string |
object (create.dto.acropolis.VMDiskSpecCloneDTO) | |
object (create.dto.uhura.VmDiskCloneDTO) |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/images \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "annotation": "string", "image_import_spec": { "checksum": "string", "checksum_type": "SHA_256", "container_id": 0, "container_name": "string", "container_uuid": "string", "storage_container_id": 0, "storage_container_name": "string", "storage_container_uuid": "string", "url": "string" }, "image_type": "DISK_IMAGE", "logical_timestamp": 0, "name": "string", "uuid": "string", "vm_disk_clone": { "container_uuid": "string", "image_path": "string", "minimum_size": 0, "minimum_size_mb": 0, "ndfs_filepath": "string", "snapshot_group_id": "string", "vm_disk_uuid": "string", "vmdisk_uuid": "string" }, "vm_disk_clone_spec": { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "minimum_size": 0, "snapshot_group_uuid": "string", "storage_container_uuid": "string" } }'
{- "task_uuid": "string"
}
Delete a Disk Image. This is an idempotent operation. The logical timestamp can optionally be provided for consistency. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the Image logical timestamp. The logical timestamp can be obtained from the Image Info object. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
uuid required | string Id of the Image |
logical_timestamp | integer <int64> Logical timestamp for synchronized delete |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/images/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "task_uuid": "string"
}
Get details of a specific Disk Image based on the given Id.
uuid required | string Id of the Image |
include_vm_disk_sizes | boolean Include VmDisk size |
include_vm_disk_paths | boolean Include VmDisk path |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/images/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "annotation": "string",
- "checksum": "string",
- "checksum_type": "SHA_256",
- "container_id": 0,
- "container_uuid": "string",
- "created_time_in_usecs": 0,
- "deleted": true,
- "image_state": "ACTIVE",
- "image_type": "DISK_IMAGE",
- "logical_timestamp": 0,
- "name": "string",
- "storage_container_id": 0,
- "storage_container_uuid": "string",
- "updated_time_in_usecs": 0,
- "uuid": "string",
- "vm_disk_id": "string",
- "vm_disk_path": "string",
- "vm_disk_size": 0
}
Get the list of Images
include_vm_disk_sizes | boolean Include VmDisk sizes |
include_vm_disk_paths | boolean Include VmDisk paths |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/images \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "annotation": "string",
- "checksum": "string",
- "checksum_type": "SHA_256",
- "container_id": 0,
- "container_uuid": "string",
- "created_time_in_usecs": 0,
- "deleted": true,
- "image_state": "ACTIVE",
- "image_type": "DISK_IMAGE",
- "logical_timestamp": 0,
- "name": "string",
- "storage_container_id": 0,
- "storage_container_uuid": "string",
- "updated_time_in_usecs": 0,
- "uuid": "string",
- "vm_disk_id": "string",
- "vm_disk_path": "string",
- "vm_disk_size": 0
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Update a Disk Image. Fields that are not set or are not specified are ignored. If an Image is already in ACTIVE state then its source can be updated. But you can still update the image name, image type and image annotation.If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the Image logical timestamp. The logical timestamp can be obtained from the Image object.
uuid required | string Id of the Disk Image |
Disk Image Update Info
annotation | string |
object (update.dto.acropolis.ImageImportSpecDTO) | |
image_type | string Enum: "DISK_IMAGE" "ISO_IMAGE" |
logical_timestamp | integer <int64> |
name | string |
uuid | string |
object (update.dto.acropolis.VMDiskSpecCloneDTO) | |
object (update.dto.uhura.VmDiskCloneDTO) |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/images/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "annotation": "string", "image_import_spec": { "checksum": "string", "checksum_type": "SHA_256", "container_id": 0, "container_name": "string", "container_uuid": "string", "storage_container_id": 0, "storage_container_name": "string", "storage_container_uuid": "string", "url": "string" }, "image_type": "DISK_IMAGE", "logical_timestamp": 0, "name": "string", "uuid": "string", "vm_disk_clone": { "container_uuid": "string", "image_path": "string", "minimum_size": 0, "minimum_size_mb": 0, "ndfs_filepath": "string", "snapshot_group_id": "string", "vm_disk_uuid": "string", "vmdisk_uuid": "string" }, "vm_disk_clone_spec": { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "minimum_size": 0, "snapshot_group_uuid": "string", "storage_container_uuid": "string" } }'
{- "task_uuid": "string"
}
uuid required | string UUID of the Iscsi client |
Update Iscsi client
client_address | string |
Array of objects (update.dto.acropolis.volumegroups.ClientAuthenticationDTO) | |
uuid | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/iscsi_clients/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "client_address": "string", "enabled_authentications": [ { "auth_type": "CHAP", "password": "string" } ], "uuid": "string" }'
{- "client_address": "string",
- "enabled_authentications": [
- {
- "auth_type": "CHAP",
- "password": "string"
}
], - "uuid": "string"
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/iscsi_clients \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "client_address": "string",
- "enabled_authentications": [
- {
- "auth_type": "CHAP",
- "password": "string"
}
], - "uuid": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
uuid required | string Unique identifier for the iscsi client |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/iscsi_clients/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "client_address": "string",
- "enabled_authentications": [
- {
- "auth_type": "CHAP",
- "password": "string"
}
], - "uuid": "string"
}
Add a Key Management Server to the cluster.
A Key Management Server instance
active | boolean |
Array of objects (create.common.Address) | |
object | |
name | string |
uuid | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/key_management_servers \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "active": true, "address_list": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "ip_address_port_map": { "property1": 0, "property2": 0 }, "name": "string", "uuid": "string" }'
{- "active": true,
- "address_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "ip_address_port_map": {
- "property1": 0,
- "property2": 0
}, - "name": "string",
- "uuid": "string"
}
Delete a KeyManagementServer with the specified name.
name required | string Name of the Key Management Server |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/key_management_servers/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/key_management_servers \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "active": true,
- "address_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "ip_address_port_map": {
- "property1": 0,
- "property2": 0
}, - "name": "string",
- "uuid": "string"
}
]
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/key_management_servers/type \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "force_update_config": true,
- "kms_type": "EKM",
- "skip_cluster_size_check": true
}
Get Key Management Server specified by the name.
name required | string Name of the Key Management Server |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/key_management_servers/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "active": true,
- "address_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "ip_address_port_map": {
- "property1": 0,
- "property2": 0
}, - "name": "string",
- "uuid": "string"
}
Modify the KeyManagementServer configuration.
A Key Management Server instance
cluster_uuid | string |
object (patch.dto.appliance.configuration.KeyManagementServerDTO) | |
operation | string |
curl --request PATCH \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/key_management_servers \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid": "string", "generic_dto": { "active": true, "address_list": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "ip_address_port_map": { "property1": 0, "property2": 0 }, "name": "string", "uuid": "string" }, "operation": "string" }'
{- "active": true,
- "address_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "ip_address_port_map": {
- "property1": 0,
- "property2": 0
}, - "name": "string",
- "uuid": "string"
}
Select Key Management Server Type to be LKM or EKM.
Type of the Key Management Server
force_update_config | boolean |
kms_type | string Enum: "EKM" "LKM" "PCKM" |
skip_cluster_size_check | boolean |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/key_management_servers/type \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "force_update_config": true, "kms_type": "EKM", "skip_cluster_size_check": true }'
{- "value": true
}
Update the KeyManagementServer configuration.
force_update | boolean Set when you need to updateKey Management Server that is currently storing encryption keys for the cluster |
A Key Management Server instance
active | boolean |
Array of objects (update.common.Address) | |
object | |
name | string |
uuid | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/key_management_servers \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "active": true, "address_list": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "ip_address_port_map": { "property1": 0, "property2": 0 }, "name": "string", "uuid": "string" }'
{- "active": true,
- "address_list": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "ip_address_port_map": {
- "property1": 0,
- "property2": 0
}, - "name": "string",
- "uuid": "string"
}
Blacklist an IP address from being used by a managed network. A blacklisted IP address cannot be assigned to a VM network adapter. This property may be useful for avoiding conflicts between VMs and other hosts on the physical network. The logical timestamp can optionally be provided for consistency. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the virtual network logical timestamp. The logical timestamp can be obtained from the virtual network object.
uuid required | string Id of the network |
IP address to reserve
value | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/networks/{uuid}/blacklist_ip_addresses \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": "string" }'
{- "value": true
}
Create a network with specified L2 and L3 configuration. Each VM network interface is bound to a virtual network (see POST /vms/nic_create/). While a virtual network is in use by a VM, it cannot be modified or deleted. Currently, the only supported L2 type is VLAN. Each virtual network is bound to a single VLAN, and trunking VLANs to a virtual network is not supported. A virtual network on VLAN 66 would be named vlan.66 . Each virtual network maps to a hypervisor-specific default vswitch. On KVM, this is br0 . To use a different vswitch (e.g., with different uplinks), you can append the vswitch name to the network identifier. For example, vlan.66.br1 . This virtual switch should exists on all hosts, and the physical switch ports for the vswitch uplinks are properly configured to receive VLAN-tagged traffic. On hypervisors where it is supported, a virtual network may have an IPv4 configuration. Such a network is a managed L3 network. A network without a IPv4 configuration is an unmanaged L3 network. A network must be configured as managed L3 or unmanaged L3 at creation time. It is not possible to convert one to the other. A particular L2 (i.e., a particular VLAN) may have at most one managed network defined at a time. To create a managed network, the user specifies the ipConfig . This consists of an IPv4 default gateway address and subnet in CIDR notation. The user may optionally specify a DHCP server address, to avoid conflict with other services on the network. By default, the last available host address in the subnet is used. Every virtual NIC on a managed network must be assigned an IPv4 address at NIC creation time. All DHCP traffic on the network will be rerouted to an internal DHCP server, who hands out configured IPv4 addresses. DHCP traffic on the physical network will not reach the virtual network, and vice versa. A managed network may have zero or more non-overlapping DHCP pools. Each pool must be entirely contained within the network s managed subnet. In the absence of a DHCP pool, the user must specify an IPv4 address when creating a virtual network adapter (see POST /vms/nic_create). If the managed network has a DHCP pool, the user need not provide an address; the NIC will automatically be assigned an IPv4 address from one of the pools at creation time, provided at least one address is available. Addresses in the DHCP pool are not reserved. That is, a user may manually specify an address belonging to the pool when creating a virtual adapter.
Network config info
annotation | string |
object (create.dto.acropolis.IpConfigDTO) | |
logical_timestamp | integer <int64> |
name | string |
network_type | string Enum: "EXTERNAL" "INTERNAL" |
uuid | string |
virtual_switch_uuid | string |
vlan_id | integer <int32> |
vswitch_name | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/networks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "annotation": "string", "ip_config": { "assigned_ips": 0, "default_gateway": "string", "dhcp_options": { "boot_file_name": "string", "domain_name": "string", "domain_name_servers": "string", "domain_search": "string", "tftp_server_name": "string" }, "dhcp_server_address": "string", "free_ips": 0, "ipam_enabled": true, "network_address": "string", "num_macs": 0, "pool": [ { "num_free_ips": 0, "num_total_ips": 0, "range": "string" } ], "prefix_length": 0 }, "logical_timestamp": 0, "name": "string", "network_type": "EXTERNAL", "uuid": "string", "virtual_switch_uuid": "string", "vlan_id": 0, "vswitch_name": "string" }'
{- "network_uuid": "string"
}
Delete a network. A network cannot be deleted while Virtual Machines are still attached to it. The logical timestamp can optionally be provided for consistency. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the virtual network logical timestamp. The logical timestamp can be obtained from the virtual network object.
uuid required | string Id of the network |
logical_timestamp | integer <int64> Logical timestamp for synchronized delete |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/networks/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Get info of a network in the cluster.
uuid required | string UUID of the network |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/networks/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "annotation": "string",
- "ip_config": {
- "assigned_ips": 0,
- "default_gateway": "string",
- "dhcp_options": {
- "boot_file_name": "string",
- "domain_name": "string",
- "domain_name_servers": "string",
- "domain_search": "string",
- "tftp_server_name": "string"
}, - "dhcp_server_address": "string",
- "free_ips": 0,
- "ipam_enabled": true,
- "network_address": "string",
- "num_macs": 0,
- "pool": [
- {
- "num_free_ips": 0,
- "num_total_ips": 0,
- "range": "string"
}
], - "prefix_length": 0
}, - "logical_timestamp": 0,
- "name": "string",
- "network_type": "EXTERNAL",
- "uuid": "string",
- "virtual_switch_uuid": "string",
- "vlan_id": 0,
- "vswitch_name": "string"
}
Get IP addresses assigned in the specified managed network.
uuid required | string Id of the network |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/networks/{uuid}/addresses \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "deleted": true,
- "entity_uuid": "string",
- "ip_address": "string",
- "mac_address": "string",
- "network_uuid": "string",
- "overlay_network_id": 0,
- "type": "VM",
- "vm_name": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get list of networks configured in the cluster.
includeOverlaySubnets | boolean Whether to also include overlay subnets in response |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/networks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "annotation": "string",
- "ip_config": {
- "assigned_ips": 0,
- "default_gateway": "string",
- "dhcp_options": {
- "boot_file_name": "string",
- "domain_name": "string",
- "domain_name_servers": "string",
- "domain_search": "string",
- "tftp_server_name": "string"
}, - "dhcp_server_address": "string",
- "free_ips": 0,
- "ipam_enabled": true,
- "network_address": "string",
- "num_macs": 0,
- "pool": [
- {
- "num_free_ips": 0,
- "num_total_ips": 0,
- "range": "string"
}
], - "prefix_length": 0
}, - "logical_timestamp": 0,
- "name": "string",
- "network_type": "EXTERNAL",
- "uuid": "string",
- "virtual_switch_uuid": "string",
- "vlan_id": 0,
- "vswitch_name": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Remove an IP address from the blacklist that prevents it from being used by the managed network. The logical timestamp can optionally be provided for consistency. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the virtual network logical timestamp. The logical timestamp can be obtained from the virtual network object.
uuid required | string Id of the network |
ipaddress required | string IP address |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/networks/{uuid}/blacklist_ip/{ipaddress} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Update a network. The logical timestamp can optionally be provided for consistency. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the virtual network logical timestamp. The logical timestamp can be obtained from the virtual network object.
uuid required | string UUID of the network |
Updated network spec
annotation | string |
object (update.dto.acropolis.IpConfigDTO) | |
logical_timestamp | integer <int64> |
name | string |
network_type | string Enum: "EXTERNAL" "INTERNAL" |
uuid | string |
virtual_switch_uuid | string |
vlan_id | integer <int32> |
vswitch_name | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/networks/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "annotation": "string", "ip_config": { "assigned_ips": 0, "default_gateway": "string", "dhcp_options": { "boot_file_name": "string", "domain_name": "string", "domain_name_servers": "string", "domain_search": "string", "tftp_server_name": "string" }, "dhcp_server_address": "string", "free_ips": 0, "ipam_enabled": true, "network_address": "string", "num_macs": 0, "pool": [ { "num_free_ips": 0, "num_total_ips": 0, "range": "string" } ], "prefix_length": 0 }, "logical_timestamp": 0, "name": "string", "network_type": "EXTERNAL", "uuid": "string", "virtual_switch_uuid": "string", "vlan_id": 0, "vswitch_name": "string" }'
{- "value": true
}
Abort a replication in a Protection Domain.
protection_domain_name required | string Name of the Protection Domain |
id required | integer <int64> Id of the replication |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{protection_domain_name}/replications/{id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Activate a protection domain with the specified name.
name required | string Name of the Protection Domain |
Id of the snapshot
value | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/activate \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": "string" }'
{- "value": true
}
Add a out of band(i.e one time) snapshot schedule in a Protection Domain having specified name.
name required | string Name of the Protection Domain |
A Out of band snapshot schedule instance
app_consistent | boolean |
remote_site_names | Array of strings |
schedule_id | integer <int64> |
schedule_start_time_usecs | integer <int64> |
snapshot_retention_time_secs | integer <int32> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/oob_schedules \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "app_consistent": true, "remote_site_names": [ "string" ], "schedule_id": 0, "schedule_start_time_usecs": 0, "snapshot_retention_time_secs": 0 }'
{- "app_consistent": true,
- "remote_site_names": [
- "string"
], - "schedule_id": 0,
- "schedule_start_time_usecs": 0,
- "snapshot_retention_time_secs": 0
}
A protection domain to be used for Disaster Recovery and Backups.
A Protection Domain instance
annotations | Array of strings |
value | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "annotations": [ "string" ], "value": "string" }'
{- "active": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "annotations": [
- "string"
], - "cron_schedules": [
- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "hybrid_schedules_count": 0,
- "marked_for_removal": true,
- "metro_avail": {
- "container": "string",
- "failure_handling": "NONE",
- "per_vm_consistency": true,
- "remote_site": "string",
- "role": "ACTIVE",
- "skip_clones_check": true,
- "status": "ENABLE_METRO_AVAIL_IN_PROGRESS",
- "storage_container": "string",
- "timeout": 10,
- "vm_agnostic_snapshots": true
}, - "min_snapshot_to_retain": 0,
- "name": "string",
- "next_snapshot_time_usecs": 0,
- "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "ongoing_replication_count": 0,
- "pending_replication_count": 0,
- "remote_site_names": [
- "string"
], - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "schedules_suspended": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "sync_replications": [
- {
- "id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_user_written_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
], - "vstore_id": 0
}
Add a snapshot schedule to the specified Protection Domain.
name required | string Name of the Protection Domain |
A snapshot schedule instance
app_consistent | boolean |
duration_in_usecs | integer <int64> |
end_time_in_usecs | integer <int64> |
every_nth | integer <int32> |
id | string |
is_rollup_sched | boolean |
pd_name | string |
object (create.dto.dr.RetentionPolicyDTO) | |
rollup_schedule_uuid | string |
start_times_in_usecs | Array of integers <int64> [ items <int64 > ] |
suspended | boolean |
timezone_offset | integer <int32> |
type | string Enum: "SECONDLY" "MINUTELY" "HOURLY" "DAILY" "WEEKLY" "MONTHLY" |
user_start_time_in_usecs | integer <int64> |
values | Array of integers <int32> [ items <int32 > ] |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/schedules \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "app_consistent": true, "duration_in_usecs": 0, "end_time_in_usecs": 0, "every_nth": 0, "id": "string", "is_rollup_sched": true, "pd_name": "string", "retention_policy": { "default_local_retention": 0, "default_remote_retention": 0, "local_max_snapshots": 0, "local_retention_period": 0, "local_retention_type": "NUM_SNAPSHOTS", "remote_max_snapshots": { "property1": 0, "property2": 0 }, "remote_retention_period": { "property1": 0, "property2": 0 }, "remote_retention_type": { "property1": "NUM_SNAPSHOTS", "property2": "NUM_SNAPSHOTS" } }, "rollup_schedule_uuid": "string", "start_times_in_usecs": [ 0 ], "suspended": true, "timezone_offset": 0, "type": "SECONDLY", "user_start_time_in_usecs": 0, "values": [ 0 ] }'
{- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
Add Virtual Machines to a Protection Domain to enable Backup and disaster recovery.
name required | string Name of the Protection Domain |
Add VMs request instance
app_consistent_snapshots | boolean |
consistency_group_name | string |
ids | Array of strings |
ignore_dup_or_missing_vms | boolean |
names | Array of strings |
uuids | Array of strings |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/protect_vms \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "app_consistent_snapshots": true, "consistency_group_name": "string", "ids": [ "string" ], "ignore_dup_or_missing_vms": true, "names": [ "string" ], "uuids": [ "string" ] }'
{- "active": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "annotations": [
- "string"
], - "cron_schedules": [
- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "hybrid_schedules_count": 0,
- "marked_for_removal": true,
- "metro_avail": {
- "container": "string",
- "failure_handling": "NONE",
- "per_vm_consistency": true,
- "remote_site": "string",
- "role": "ACTIVE",
- "skip_clones_check": true,
- "status": "ENABLE_METRO_AVAIL_IN_PROGRESS",
- "storage_container": "string",
- "timeout": 10,
- "vm_agnostic_snapshots": true
}, - "min_snapshot_to_retain": 0,
- "name": "string",
- "next_snapshot_time_usecs": 0,
- "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "ongoing_replication_count": 0,
- "pending_replication_count": 0,
- "remote_site_names": [
- "string"
], - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "schedules_suspended": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "sync_replications": [
- {
- "id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_user_written_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
], - "vstore_id": 0
}
Change failure handling mode for a protection domain
pd_name required | string Name of the Protection Domain |
Protection domain name and Failure handling mode
failure_handling_mode | string Enum: "NONE" "AUTOMATIC" "MANUAL" "WITNESS" "PENDING" |
local_only | boolean |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{pd_name}/failure_handling \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "failure_handling_mode": "NONE", "local_only": true }'
{- "active": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "annotations": [
- "string"
], - "cron_schedules": [
- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "hybrid_schedules_count": 0,
- "marked_for_removal": true,
- "metro_avail": {
- "container": "string",
- "failure_handling": "NONE",
- "per_vm_consistency": true,
- "remote_site": "string",
- "role": "ACTIVE",
- "skip_clones_check": true,
- "status": "ENABLE_METRO_AVAIL_IN_PROGRESS",
- "storage_container": "string",
- "timeout": 10,
- "vm_agnostic_snapshots": true
}, - "min_snapshot_to_retain": 0,
- "name": "string",
- "next_snapshot_time_usecs": 0,
- "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "ongoing_replication_count": 0,
- "pending_replication_count": 0,
- "remote_site_names": [
- "string"
], - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "schedules_suspended": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "sync_replications": [
- {
- "id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_user_written_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
], - "vstore_id": 0
}
Clear retention policies of specified snapshot scheudule from the specified Protection Domain.
pd_name required | string Name of the Protection Domain |
id required | string ID of the snapshot schedule |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{pd_name}/schedules/{id}/retention_policies \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
Deactivate a protection domain. If you delete this protection domain after this, it will destroy all the VMs and VGs protected in this protection domain.
name required | string Name of the Protection Domain |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/deactivate \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Delete a Out-Of-Band schedule having specified id.
name required | string Name of the Protection Domain |
schedule_id required | integer <int64> Id of the Out-Of-Band schedule |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/oob_schedules/{schedule_id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Mark a Protection domain for removal. Protection domain will be removed from the cluster when all outstanding operations on it are cancelled.
name required | string Name of the Protection Domain |
skip_remote_check | boolean Skip checking remote Protection Domain |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Delete a snapshot of a Protection Domain.
protection_domain_name required | string Name of the Protection Domain |
snapshot_id required | string Id of the snapshot |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{protection_domain_name}/dr_snapshots/{snapshot_id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Disables Metro Availability for a specific protection domain.
pd_name required | string Name of the Protection Domain |
skip_remote_check | boolean Skip checking remote Protection Domain |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{pd_name}/metro_avail_disable \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "active": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "annotations": [
- "string"
], - "cron_schedules": [
- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "hybrid_schedules_count": 0,
- "marked_for_removal": true,
- "metro_avail": {
- "container": "string",
- "failure_handling": "NONE",
- "per_vm_consistency": true,
- "remote_site": "string",
- "role": "ACTIVE",
- "skip_clones_check": true,
- "status": "ENABLE_METRO_AVAIL_IN_PROGRESS",
- "storage_container": "string",
- "timeout": 10,
- "vm_agnostic_snapshots": true
}, - "min_snapshot_to_retain": 0,
- "name": "string",
- "next_snapshot_time_usecs": 0,
- "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "ongoing_replication_count": 0,
- "pending_replication_count": 0,
- "remote_site_names": [
- "string"
], - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "schedules_suspended": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "sync_replications": [
- {
- "id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_user_written_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
], - "vstore_id": 0
}
Enables Metro Availability for a specific protection domain based on VStore and remote site.
pd_name required | string Name of the Protection Domain |
re_enable | boolean Re-enable operation |
skip_remote_check | boolean Skip checking remote Protection Domain |
force | boolean Skip checking remote container emptiness |
skip_clones_check | boolean Skip clones check |
VStore name and Remote site name
container | string |
failure_handling | string Enum: "NONE" "AUTOMATIC" "MANUAL" "WITNESS" "PENDING" |
per_vm_consistency | boolean |
remote_site | string |
role | string Enum: "ACTIVE" "STANDBY" "DEACTIVATED" |
skip_clones_check | boolean |
status | string Enum: "ENABLE_METRO_AVAIL_IN_PROGRESS" "DISABLE_METRO_AVAIL_IN_PROGRESS" "PROMOTE_METRO_AVAIL_IN_PROGRESS" "DEMOTE_METRO_AVAIL_IN_PROGRESS" "REMOTE_UNREACHABLE" "DECOUPLED" "SYNCHRONIZING" "ENABLED" "DISABLED" "SYNC_INCOMPLETE" "PENDING" "ERROR" |
storage_container | string |
timeout | integer <int64> [ 10 .. 30 ] |
vm_agnostic_snapshots | boolean |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{pd_name}/metro_avail_enable \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "container": "string", "failure_handling": "NONE", "per_vm_consistency": true, "remote_site": "string", "role": "ACTIVE", "skip_clones_check": true, "status": "ENABLE_METRO_AVAIL_IN_PROGRESS", "storage_container": "string", "timeout": 10, "vm_agnostic_snapshots": true }'
{- "active": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "annotations": [
- "string"
], - "cron_schedules": [
- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "hybrid_schedules_count": 0,
- "marked_for_removal": true,
- "metro_avail": {
- "container": "string",
- "failure_handling": "NONE",
- "per_vm_consistency": true,
- "remote_site": "string",
- "role": "ACTIVE",
- "skip_clones_check": true,
- "status": "ENABLE_METRO_AVAIL_IN_PROGRESS",
- "storage_container": "string",
- "timeout": 10,
- "vm_agnostic_snapshots": true
}, - "min_snapshot_to_retain": 0,
- "name": "string",
- "next_snapshot_time_usecs": 0,
- "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "ongoing_replication_count": 0,
- "pending_replication_count": 0,
- "remote_site_names": [
- "string"
], - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "schedules_suspended": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "sync_replications": [
- {
- "id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_user_written_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
], - "vstore_id": 0
}
Get a Protection Domain with the specified name.
name required | string Name of the Protection Domain |
metro_avail | boolean Whether to include only Metro Availability related protection domains |
vstore_name | string vStore name |
remote_site_name | string Remote Site name |
remote_site_to_forward | string Remote Site to forward |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "active": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "annotations": [
- "string"
], - "cron_schedules": [
- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "hybrid_schedules_count": 0,
- "marked_for_removal": true,
- "metro_avail": {
- "container": "string",
- "failure_handling": "NONE",
- "per_vm_consistency": true,
- "remote_site": "string",
- "role": "ACTIVE",
- "skip_clones_check": true,
- "status": "ENABLE_METRO_AVAIL_IN_PROGRESS",
- "storage_container": "string",
- "timeout": 10,
- "vm_agnostic_snapshots": true
}, - "min_snapshot_to_retain": 0,
- "name": "string",
- "next_snapshot_time_usecs": 0,
- "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "ongoing_replication_count": 0,
- "pending_replication_count": 0,
- "remote_site_names": [
- "string"
], - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "schedules_suspended": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "sync_replications": [
- {
- "id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_user_written_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
], - "vstore_id": 0
}
Get list of Consistency groups in a specified Protection Domain.
name required | string Name of the Protection Domain |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/consistency_groups \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "app_consistent_snapshots": true,
- "consistency_group_name": "string",
- "marked_for_removal": true,
- "nfs_file_count": 0,
- "protection_domain_name": "string",
- "total_file_count": 0,
- "total_file_size_bytes": 0,
- "vm_count": 0,
- "within_snapshot": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get list of Consistency groups in the cluster.
protection_domains | Array of strings Protection Domain names |
consistency_groups | Array of strings Consistency Group names |
include_deleted | boolean Include deleted |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/consistency_groups \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "app_consistent_snapshots": true,
- "consistency_group_name": "string",
- "marked_for_removal": true,
- "nfs_file_count": 0,
- "protection_domain_name": "string",
- "total_file_count": 0,
- "total_file_size_bytes": 0,
- "vm_count": 0,
- "within_snapshot": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get list of pending actions in the specified Protection Domain.
name required | string Name of the Protection Domain |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/pending_actions \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "has_pending_actions": true,
- "marked_for_removal": true,
- "pending_change_mode": {
- "failover_remote": "string",
- "mode_type": "ACTIVATE_PD",
- "snapshot_id": "string"
}, - "pending_nfs_files_restore": [
- {
- "name": "string",
- "path_prefix": "string",
- "replace_entity": true,
- "snapshot_id": "string"
}
], - "pending_replications": [
- {
- "remote_site": "string",
- "snapshot_ids": [
- "string"
]
}
], - "pending_vms_restore": [
- {
- "name": "string",
- "path_prefix": "string",
- "replace_entity": true,
- "snapshot_id": "string"
}
], - "protection_domain_name": "string",
- "to_be_removed_nfs_files": [
- "string"
], - "to_be_removed_snapshots": [
- "string"
], - "to_be_removed_vms": [
- "string"
]
}
]
Get list of pending actions in the cluster.
protection_domain_names | Array of strings Names of Protection Domains |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/pending_actions \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "has_pending_actions": true,
- "marked_for_removal": true,
- "pending_change_mode": {
- "failover_remote": "string",
- "mode_type": "ACTIVATE_PD",
- "snapshot_id": "string"
}, - "pending_nfs_files_restore": [
- {
- "name": "string",
- "path_prefix": "string",
- "replace_entity": true,
- "snapshot_id": "string"
}
], - "pending_replications": [
- {
- "remote_site": "string",
- "snapshot_ids": [
- "string"
]
}
], - "pending_vms_restore": [
- {
- "name": "string",
- "path_prefix": "string",
- "replace_entity": true,
- "snapshot_id": "string"
}
], - "protection_domain_name": "string",
- "to_be_removed_nfs_files": [
- "string"
], - "to_be_removed_snapshots": [
- "string"
], - "to_be_removed_vms": [
- "string"
]
}
]
Get list of pending replications in the Protection Domain with the specified name.
name required | string Name of the Protection Domain |
remote_site_names | Array of strings Names of Remote Sites |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/pending_replications \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "snapshot": {
- "consistency_groups": [
- "string"
], - "exclusive_usage_in_bytes": 0,
- "located_remote_site_name": "string",
- "missing_entities": [
- {
- "cg_name": "string",
- "entity_name": "string",
- "entity_type": "string"
}
], - "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "oob_schedule_ids": [
- 0
], - "protection_domain_name": "string",
- "remote_site_names": [
- "string"
], - "size_in_bytes": 0,
- "snapshot_create_time_usecs": 0,
- "snapshot_expiry_time_usecs": 0,
- "snapshot_id": "string",
- "snapshot_uuid": "string",
- "state": "EXPIRED",
- "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
]
}
}
]
Get list of pending replications in the cluster.
protection_domain_names | Array of strings Protection Domain names |
remote_site_names | Array of strings Remote Site names |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/pending_replications \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "snapshot": {
- "consistency_groups": [
- "string"
], - "exclusive_usage_in_bytes": 0,
- "located_remote_site_name": "string",
- "missing_entities": [
- {
- "cg_name": "string",
- "entity_name": "string",
- "entity_type": "string"
}
], - "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "oob_schedule_ids": [
- 0
], - "protection_domain_name": "string",
- "remote_site_names": [
- "string"
], - "size_in_bytes": 0,
- "snapshot_create_time_usecs": 0,
- "snapshot_expiry_time_usecs": 0,
- "snapshot_id": "string",
- "snapshot_uuid": "string",
- "state": "EXPIRED",
- "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
]
}
}
]
name required | string Name of the Protection Domain |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/replications \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "aborted": true,
- "completed_bytes": 0,
- "completed_percentage": 0.1,
- "id": 0,
- "paused": true,
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "replication_time_to_complete_secs": 0,
- "sender": true,
- "snapshot_id": "string",
- "start_replication_time_usecs": 0
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get list of replications in the cluster.
protection_domain_names | Array of strings Protection Domain names |
remote_site_names | Array of strings Remote Site names |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/replications \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "aborted": true,
- "completed_bytes": 0,
- "completed_percentage": 0.1,
- "id": 0,
- "paused": true,
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "replication_time_to_complete_secs": 0,
- "sender": true,
- "snapshot_id": "string",
- "start_replication_time_usecs": 0
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get list of unprotected VMs in a cluster that can participate in Nutanix native Backup and DR.
host_uuids | Array of strings Host Uuids |
vm_ids | Array of strings VM IDs |
vm_names | Array of strings VM Names |
storage_container_names | Array of strings Storage Container Names |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/unprotected_vms \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acropolis_vm": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "cluster_uuid": "string",
- "consistency_group_name": "string",
- "container_ids": [
- "string"
], - "container_uuids": [
- "string"
], - "control_domain": true,
- "controller_vm": true,
- "cpu_reserved_in_hz": 0,
- "description": "string",
- "disk_capacity_in_bytes": 0,
- "displayable": true,
- "finger_print_on_write": "NONE",
- "gpus_in_use": true,
- "guest_operating_system": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "host_id": "string",
- "host_name": "string",
- "host_uuid": "string",
- "hypervisor_type": "string",
- "ip_addresses": [
- "string"
], - "memory_capacity_in_bytes": 0,
- "memory_reserved_capacity_in_bytes": 0,
- "non_ndfs_details": "string",
- "num_network_adapters": 0,
- "num_vcpus": 0,
- "nutanix_guest_tools": {
- "applications": {
- "property1": true,
- "property2": true
}, - "cluster_version": "string",
- "communication_link_active": true,
- "enabled": true,
- "installed_version": "string",
- "to_remove": true,
- "tools_mounted": true,
- "vm_id": "string",
- "vm_name": "string",
- "vm_uuid": "string"
}, - "nutanix_virtual_disk_ids": [
- "string"
], - "nutanix_virtual_disk_uuids": [
- "string"
], - "nutanix_virtual_disks": [
- "string"
], - "on_disk_dedup": "NONE",
- "power_state": "string",
- "protection_domain_name": "string",
- "protection_type": "string",
- "running_on_ndfs": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "storage_container_ids": [
- "string"
], - "storage_container_uuids": [
- "string"
], - "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vdisk_file_paths": [
- "string"
], - "vdisk_names": [
- "string"
], - "virtual_gpu_uuids": [
- "string"
], - "virtual_nic_ids": [
- "string"
], - "virtual_nic_uuids": [
- "string"
], - "vm_features": {
- "property1": true,
- "property2": true
}, - "vm_id": "string",
- "vm_name": "string",
- "vm_type": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/status \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "active_replications": true,
- "pd_suspended_schedules_map": {
- "property1": true,
- "property2": true
}
}
name required | string Name of the Protection Domain |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
name required | string Name of the Protection Domain |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of Out-Of-Band schedules in a Protection Domain with the specified name.
name required | string Name of the Protection Domain |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/oob_schedules \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "pd_name": "string",
- "schedule_map": {
- "property1": {
- "app_consistent": true,
- "remote_site_names": [
- "string"
], - "schedule_id": 0,
- "schedule_start_time_usecs": 0,
- "snapshot_retention_time_secs": 0
}, - "property2": {
- "app_consistent": true,
- "remote_site_names": [
- "string"
], - "schedule_id": 0,
- "schedule_start_time_usecs": 0,
- "snapshot_retention_time_secs": 0
}
}
}
]
Get the list of Out-Of-Band schedules in Protection Domains configured in the cluster.
protection_domain_names | Array of strings Names of Protection Domains |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/oob_schedules \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "pd_name": "string",
- "schedule_map": {
- "property1": {
- "app_consistent": true,
- "remote_site_names": [
- "string"
], - "schedule_id": 0,
- "schedule_start_time_usecs": 0,
- "snapshot_retention_time_secs": 0
}, - "property2": {
- "app_consistent": true,
- "remote_site_names": [
- "string"
], - "schedule_id": 0,
- "schedule_start_time_usecs": 0,
- "snapshot_retention_time_secs": 0
}
}
}
]
Get the list of Protection Domains configured in the cluster.
names | Array of strings Protection Domain names |
metro_avail | boolean Metro Availability Protection Domain |
vstore_name | string vStore name |
remote_site_name | string Remote Site name |
remote_site_to_forward | string Remote Site to forward |
include_deleted | boolean Include deleted |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "active": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "annotations": [
- "string"
], - "cron_schedules": [
- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "hybrid_schedules_count": 0,
- "marked_for_removal": true,
- "metro_avail": {
- "container": "string",
- "failure_handling": "NONE",
- "per_vm_consistency": true,
- "remote_site": "string",
- "role": "ACTIVE",
- "skip_clones_check": true,
- "status": "ENABLE_METRO_AVAIL_IN_PROGRESS",
- "storage_container": "string",
- "timeout": 10,
- "vm_agnostic_snapshots": true
}, - "min_snapshot_to_retain": 0,
- "name": "string",
- "next_snapshot_time_usecs": 0,
- "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "ongoing_replication_count": 0,
- "pending_replication_count": 0,
- "remote_site_names": [
- "string"
], - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "schedules_suspended": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "sync_replications": [
- {
- "id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_user_written_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
], - "vstore_id": 0
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of Snapshots created in a specified Protection Domain.
name required | string Name of the Protection Domain |
count | integer <int32> Number of DR Snapshots to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
full_details | boolean Whether to include consistency group / vm details |
oob_schedule_ids | Array of integers <int64> [ items <int64 > ] OOB Schedule Ids for filtering |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/dr_snapshots \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "consistency_groups": [
- "string"
], - "exclusive_usage_in_bytes": 0,
- "located_remote_site_name": "string",
- "missing_entities": [
- {
- "cg_name": "string",
- "entity_name": "string",
- "entity_type": "string"
}
], - "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "oob_schedule_ids": [
- 0
], - "protection_domain_name": "string",
- "remote_site_names": [
- "string"
], - "size_in_bytes": 0,
- "snapshot_create_time_usecs": 0,
- "snapshot_expiry_time_usecs": 0,
- "snapshot_id": "string",
- "snapshot_uuid": "string",
- "state": "EXPIRED",
- "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of Snapshots created in Protection Domains.
count | integer <int32> Number of DR Snapshots to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
full_details | boolean Whether to include consistency group / vm details |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/dr_snapshots \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "consistency_groups": [
- "string"
], - "exclusive_usage_in_bytes": 0,
- "located_remote_site_name": "string",
- "missing_entities": [
- {
- "cg_name": "string",
- "entity_name": "string",
- "entity_type": "string"
}
], - "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "oob_schedule_ids": [
- 0
], - "protection_domain_name": "string",
- "remote_site_names": [
- "string"
], - "size_in_bytes": 0,
- "snapshot_create_time_usecs": 0,
- "snapshot_expiry_time_usecs": 0,
- "snapshot_id": "string",
- "snapshot_uuid": "string",
- "state": "EXPIRED",
- "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
If start time and end time are included in the query string, then historical stats are retrieved. Otherwise, the latest stats are retrieved.
name required | string Name of the Protection Domain |
metrics required | Array of strings List of metrics |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
interval_in_secs | integer <int32> Sampling interval of stats |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/stats \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "stats_specific_responses": [
- {
- "interval_in_secs": 0,
- "message": "string",
- "metric": "string",
- "start_time_in_usecs": 0,
- "successful": true,
- "values": [
- 0
]
}
]
}
name required | string |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/sra_state \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": "string"
}
name required | string |
id required | integer <int64> |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/track_oob_schedule/{id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "aborted": true,
- "completed_bytes": 0,
- "completed_percentage": 0.1,
- "id": 0,
- "paused": true,
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "replication_time_to_complete_secs": 0,
- "sender": true,
- "snapshot_id": "string",
- "start_replication_time_usecs": 0
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Mark the specified Protection domain as inactive and failover to the given Remote Site.
name required | string Name of the Protection Domain |
skip_vm_mobility_check | boolean Flag to specify whether mobility check has to be skipped |
Name of the Remote Site
value | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/migrate \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": "string" }'
{- "entities": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
name required | string |
app_consistent_snapshots | boolean |
consistency_group_name | string |
ctr_id | string |
ctr_uuid | string |
file_paths | Array of strings |
force | boolean |
host_id | string |
host_uuid | string |
ignore_dup_or_missing_vms | boolean |
protect_related_entities | boolean |
protection_domain_name | string |
vm_add_remove_type | string Enum: "LISTED_VMS" "CTR_VMS" "HOST_VMS" "NO_VMS" |
vm_ids | Array of strings |
vm_names | Array of strings |
vm_uuids | Array of strings |
volume_group_uuids | Array of strings |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/add_entities \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "app_consistent_snapshots": true, "consistency_group_name": "string", "ctr_id": "string", "ctr_uuid": "string", "file_paths": [ "string" ], "force": true, "host_id": "string", "host_uuid": "string", "ignore_dup_or_missing_vms": true, "protect_related_entities": true, "protection_domain_name": "string", "vm_add_remove_type": "LISTED_VMS", "vm_ids": [ "string" ], "vm_names": [ "string" ], "vm_uuids": [ "string" ], "volume_group_uuids": [ "string" ] }'
{- "active": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "annotations": [
- "string"
], - "cron_schedules": [
- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "hybrid_schedules_count": 0,
- "marked_for_removal": true,
- "metro_avail": {
- "container": "string",
- "failure_handling": "NONE",
- "per_vm_consistency": true,
- "remote_site": "string",
- "role": "ACTIVE",
- "skip_clones_check": true,
- "status": "ENABLE_METRO_AVAIL_IN_PROGRESS",
- "storage_container": "string",
- "timeout": 10,
- "vm_agnostic_snapshots": true
}, - "min_snapshot_to_retain": 0,
- "name": "string",
- "next_snapshot_time_usecs": 0,
- "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "ongoing_replication_count": 0,
- "pending_replication_count": 0,
- "remote_site_names": [
- "string"
], - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "schedules_suspended": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "sync_replications": [
- {
- "id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_user_written_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
], - "vstore_id": 0
}
name required | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/dr_snapshots/remove_list \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
name required | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/dr_snapshots/retain_list \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
name required | string |
List of a perioidic schedule ids
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/oob_schedules/remove_list \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
name required | string |
app_consistent_snapshots | boolean |
consistency_group_name | string |
ctr_id | string |
ctr_uuid | string |
file_paths | Array of strings |
force | boolean |
host_id | string |
host_uuid | string |
ignore_dup_or_missing_vms | boolean |
protect_related_entities | boolean |
protection_domain_name | string |
vm_add_remove_type | string Enum: "LISTED_VMS" "CTR_VMS" "HOST_VMS" "NO_VMS" |
vm_ids | Array of strings |
vm_names | Array of strings |
vm_uuids | Array of strings |
volume_group_uuids | Array of strings |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/remove_entities \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "app_consistent_snapshots": true, "consistency_group_name": "string", "ctr_id": "string", "ctr_uuid": "string", "file_paths": [ "string" ], "force": true, "host_id": "string", "host_uuid": "string", "ignore_dup_or_missing_vms": true, "protect_related_entities": true, "protection_domain_name": "string", "vm_add_remove_type": "LISTED_VMS", "vm_ids": [ "string" ], "vm_names": [ "string" ], "vm_uuids": [ "string" ], "volume_group_uuids": [ "string" ] }'
{- "active": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "annotations": [
- "string"
], - "cron_schedules": [
- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "hybrid_schedules_count": 0,
- "marked_for_removal": true,
- "metro_avail": {
- "container": "string",
- "failure_handling": "NONE",
- "per_vm_consistency": true,
- "remote_site": "string",
- "role": "ACTIVE",
- "skip_clones_check": true,
- "status": "ENABLE_METRO_AVAIL_IN_PROGRESS",
- "storage_container": "string",
- "timeout": 10,
- "vm_agnostic_snapshots": true
}, - "min_snapshot_to_retain": 0,
- "name": "string",
- "next_snapshot_time_usecs": 0,
- "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "ongoing_replication_count": 0,
- "pending_replication_count": 0,
- "remote_site_names": [
- "string"
], - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "schedules_suspended": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "sync_replications": [
- {
- "id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_user_written_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
], - "vstore_id": 0
}
name required | string |
app_consistent | boolean |
duration_in_usecs | integer <int64> |
end_time_in_usecs | integer <int64> |
every_nth | integer <int32> |
id | string |
is_rollup_sched | boolean |
pd_name | string |
object (create.dto.dr.RetentionPolicyDTO) | |
rollup_schedule_uuid | string |
start_times_in_usecs | Array of integers <int64> [ items <int64 > ] |
suspended | boolean |
timezone_offset | integer <int32> |
type | string Enum: "SECONDLY" "MINUTELY" "HOURLY" "DAILY" "WEEKLY" "MONTHLY" |
user_start_time_in_usecs | integer <int64> |
values | Array of integers <int32> [ items <int32 > ] |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/schedules/add_list \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
]
name required | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/schedules/remove_list \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
name required | string Name of the Protection Domain |
List of the names of the remote sites
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/validate_migrate \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "cluster_id": 0,
- "error_code": "string",
- "error_message": "string",
- "remote_network_mapping_configured": true,
- "remote_site_name": "string",
- "un_recoverable_vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Promotes to active Metro Availability role for a specific protection domain.
pd_name required | string Name of the Protection Domain |
skip_remote_check | boolean Skip checking remote Protection Domain |
force | boolean Force to perform the action |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{pd_name}/promote \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "active": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "annotations": [
- "string"
], - "cron_schedules": [
- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "hybrid_schedules_count": 0,
- "marked_for_removal": true,
- "metro_avail": {
- "container": "string",
- "failure_handling": "NONE",
- "per_vm_consistency": true,
- "remote_site": "string",
- "role": "ACTIVE",
- "skip_clones_check": true,
- "status": "ENABLE_METRO_AVAIL_IN_PROGRESS",
- "storage_container": "string",
- "timeout": 10,
- "vm_agnostic_snapshots": true
}, - "min_snapshot_to_retain": 0,
- "name": "string",
- "next_snapshot_time_usecs": 0,
- "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "ongoing_replication_count": 0,
- "pending_replication_count": 0,
- "remote_site_names": [
- "string"
], - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "schedules_suspended": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "sync_replications": [
- {
- "id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_user_written_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
], - "vstore_id": 0
}
name required | string |
value | integer <int32> |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/min_snapshots \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": 0 }'
{- "value": true
}
name required | string Name of the Protection Domain |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/schedules/resume \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
name required | string Name of the Protection Domain |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/schedules/suspend \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
name required | string |
value | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/sra_state \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": "string" }'
{- "value": true
}
Remove a snapshot schedule from the specified Protection Domain.
pd_name required | string Name of the Protection Domain |
id required | string Id of the snapshot schedule |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{pd_name}/schedules/{id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Remove all snapshot schedules from the specified ProtectionDomain.
pd_name required | string Name of the Protection Domain |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{pd_name}/schedules \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
name required | string Name of the Protection Domain |
List of VMs
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/unprotect_vms \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "active": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "annotations": [
- "string"
], - "cron_schedules": [
- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "hybrid_schedules_count": 0,
- "marked_for_removal": true,
- "metro_avail": {
- "container": "string",
- "failure_handling": "NONE",
- "per_vm_consistency": true,
- "remote_site": "string",
- "role": "ACTIVE",
- "skip_clones_check": true,
- "status": "ENABLE_METRO_AVAIL_IN_PROGRESS",
- "storage_container": "string",
- "timeout": 10,
- "vm_agnostic_snapshots": true
}, - "min_snapshot_to_retain": 0,
- "name": "string",
- "next_snapshot_time_usecs": 0,
- "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "ongoing_replication_count": 0,
- "pending_replication_count": 0,
- "remote_site_names": [
- "string"
], - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "schedules_suspended": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "sync_replications": [
- {
- "id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_user_written_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
], - "vstore_id": 0
}
Replace a snapshot schedule of the specified Protection Domain.
pd_name required | string Name of the Protection Domain |
id required | string Id of the snapshot schedule |
A snapshot schedule instance
app_consistent | boolean |
duration_in_usecs | integer <int64> |
end_time_in_usecs | integer <int64> |
every_nth | integer <int32> |
id | string |
is_rollup_sched | boolean |
pd_name | string |
object (update.dto.dr.RetentionPolicyDTO) | |
rollup_schedule_uuid | string |
start_times_in_usecs | Array of integers <int64> [ items <int64 > ] |
suspended | boolean |
timezone_offset | integer <int32> |
type | string Enum: "SECONDLY" "MINUTELY" "HOURLY" "DAILY" "WEEKLY" "MONTHLY" |
user_start_time_in_usecs | integer <int64> |
values | Array of integers <int32> [ items <int32 > ] |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{pd_name}/schedules/{id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "app_consistent": true, "duration_in_usecs": 0, "end_time_in_usecs": 0, "every_nth": 0, "id": "string", "is_rollup_sched": true, "pd_name": "string", "retention_policy": { "default_local_retention": 0, "default_remote_retention": 0, "local_max_snapshots": 0, "local_retention_period": 0, "local_retention_type": "NUM_SNAPSHOTS", "remote_max_snapshots": { "property1": 0, "property2": 0 }, "remote_retention_period": { "property1": 0, "property2": 0 }, "remote_retention_type": { "property1": "NUM_SNAPSHOTS", "property2": "NUM_SNAPSHOTS" } }, "rollup_schedule_uuid": "string", "start_times_in_usecs": [ 0 ], "suspended": true, "timezone_offset": 0, "type": "SECONDLY", "user_start_time_in_usecs": 0, "values": [ 0 ] }'
{- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
Replicate the given snapshot in a Protection Domain to a given remote site
name required | string Name of the Protection Domain |
snapshot_id required | string Snapshot Id |
Replicate request instance
remote_expiration_time_usecs | integer <int64> |
remote_site_name | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/snapshots/{snapshot_id}/replicate \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "remote_expiration_time_usecs": 0, "remote_site_name": "string" }'
{- "task_uuid": "string"
}
Restore Virtual Machines and/or NFS files in a Protection Domain to a given Snapshot. This returns a ?File Group UUID? through which the restored entities can be managed. The assumption is that such restored entities are short lived and have to be deleted explicitly. The APIs under ?/file_groups? namespace provide such management APIs.
Note that this API addresses a narrower use case and many users of Prism might not find it useful.
name required | string Name of the Protection Domain |
snapshot_id required | string Snapshot Id |
Restore request instance
nfs_files | Array of strings |
path_prefix | string |
replace | boolean |
restore_vm_agnostic | boolean |
snapshot_id | string |
vg_name_prefix | string |
vm_name_prefix | string |
vm_names | Array of strings |
vm_uuids | Array of strings |
volume_group_uuids | Array of strings |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/snapshots/{snapshot_id}/clone \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "nfs_files": [ "string" ], "path_prefix": "string", "replace": true, "restore_vm_agnostic": true, "snapshot_id": "string", "vg_name_prefix": "string", "vm_name_prefix": "string", "vm_names": [ "string" ], "vm_uuids": [ "string" ], "volume_group_uuids": [ "string" ] }'
{- "error_details": {
- "entity_id": "string",
- "error_code": 0,
- "error_message": "string"
}, - "file_clone_paths": [
- "string"
], - "file_group_uuid": "string",
- "protection_domain_name": "string",
- "snapshot_id": "string",
- "snapshot_uuid": "string",
- "state": "NOT_STARTED",
- "task_uuid": "string",
- "v_store_path_prefixes": [
- "string"
], - "vm_ids": [
- "string"
]
}
Retain a snapshot of a Protection Domain.
protection_domain_name required | string Name of the Protection Domain |
snapshot_id required | string Id of the snapshot |
Retention time in microseconds, If value is less thanthe current epoch time in microseconds, then it will delete this snapshot. To retain a snapshot forever give null or no value in the payload
value | integer <int64> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{protection_domain_name}/dr_snapshots/{snapshot_id}/retain \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": 0 }'
{- "value": true
}
Retrieve all snapshot schedules from the specified Protection Domain.
name required | string Name of the Protection Domain |
timezone_offset | integer <int64> Timezone offset in seconds w.r.t GMT |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/schedules \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
]
Rollback the specified active Protection domain to a given snapshot.
name required | string Name of the Protection Domain |
Id of the snapshot
value | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/rollback \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": "string" }'
{- "value": true
}
Rollback Virtual Machines and/or NFS files in a Protection Domain to a given Snapshot
name required | string Name of the Protection Domain |
Restore request instance
nfs_files | Array of strings |
path_prefix | string |
replace | boolean |
restore_vm_agnostic | boolean |
snapshot_id | string |
vg_name_prefix | string |
vm_name_prefix | string |
vm_names | Array of strings |
vm_uuids | Array of strings |
volume_group_uuids | Array of strings |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{name}/restore_entities \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "nfs_files": [ "string" ], "path_prefix": "string", "replace": true, "restore_vm_agnostic": true, "snapshot_id": "string", "vg_name_prefix": "string", "vm_name_prefix": "string", "vm_names": [ "string" ], "vm_uuids": [ "string" ], "volume_group_uuids": [ "string" ] }'
{- "task_uuid": "string",
- "value": true
}
Set retention policies of specified snapshot schedule from the specified Protection Domain.
pd_name required | string Name of the Protection Domain |
id required | string ID of the snapshot schedule |
The retention policies instance
default_local_retention | integer <int32> |
default_remote_retention | integer <int32> |
local_max_snapshots | integer <int32> |
local_retention_period | integer <int32> |
local_retention_type | string Enum: "NUM_SNAPSHOTS" "DAYS" "WEEKS" "MONTHS" |
object | |
object | |
object |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{pd_name}/schedules/{id}/retention_policies \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "default_local_retention": 0, "default_remote_retention": 0, "local_max_snapshots": 0, "local_retention_period": 0, "local_retention_type": "NUM_SNAPSHOTS", "remote_max_snapshots": { "property1": 0, "property2": 0 }, "remote_retention_period": { "property1": 0, "property2": 0 }, "remote_retention_type": { "property1": "NUM_SNAPSHOTS", "property2": "NUM_SNAPSHOTS" } }'
{- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
Update the state of the replication in a Protection Domain.
protection_domain_name required | string Name of the Protection Domain |
id required | integer <int64> Id of the replication |
One of pause, resume or abort
value | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{protection_domain_name}/replications/{id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": "string" }'
{- "value": true
}
Updates Consistency Group for a specific protection domain.
pd_name required | string Name of the Protection Domain |
cg_name required | string Name of the Consistency Group |
Consistency group details
app_consistent_snapshots | boolean |
consistency_group_name | string |
marked_for_removal | boolean |
nfs_file_count | integer <int32> |
protection_domain_name | string |
total_file_count | integer <int32> |
total_file_size_bytes | integer <int64> |
vm_count | integer <int32> |
within_snapshot | boolean |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{pd_name}/consistency_groups/{cg_name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "app_consistent_snapshots": true, "consistency_group_name": "string", "marked_for_removal": true, "nfs_file_count": 0, "protection_domain_name": "string", "total_file_count": 0, "total_file_size_bytes": 0, "vm_count": 0, "within_snapshot": true }'
{- "app_consistent_snapshots": true,
- "consistency_group_name": "string",
- "marked_for_removal": true,
- "nfs_file_count": 0,
- "protection_domain_name": "string",
- "total_file_count": 0,
- "total_file_size_bytes": 0,
- "vm_count": 0,
- "within_snapshot": true
}
Updates Metro Availability timeout for a specific protection domain.
pd_name required | string Name of the Protection Domain |
Metro Availability setting
container | string |
failure_handling | string Enum: "NONE" "AUTOMATIC" "MANUAL" "WITNESS" "PENDING" |
per_vm_consistency | boolean |
remote_site | string |
role | string Enum: "ACTIVE" "STANDBY" "DEACTIVATED" |
skip_clones_check | boolean |
status | string Enum: "ENABLE_METRO_AVAIL_IN_PROGRESS" "DISABLE_METRO_AVAIL_IN_PROGRESS" "PROMOTE_METRO_AVAIL_IN_PROGRESS" "DEMOTE_METRO_AVAIL_IN_PROGRESS" "REMOTE_UNREACHABLE" "DECOUPLED" "SYNCHRONIZING" "ENABLED" "DISABLED" "SYNC_INCOMPLETE" "PENDING" "ERROR" |
storage_container | string |
timeout | integer <int64> [ 10 .. 30 ] |
vm_agnostic_snapshots | boolean |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/protection_domains/{pd_name}/break_replication_timeout \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "container": "string", "failure_handling": "NONE", "per_vm_consistency": true, "remote_site": "string", "role": "ACTIVE", "skip_clones_check": true, "status": "ENABLE_METRO_AVAIL_IN_PROGRESS", "storage_container": "string", "timeout": 10, "vm_agnostic_snapshots": true }'
{- "active": true,
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "annotations": [
- "string"
], - "cron_schedules": [
- {
- "app_consistent": true,
- "duration_in_usecs": 0,
- "end_time_in_usecs": 0,
- "every_nth": 0,
- "id": "string",
- "is_rollup_sched": true,
- "pd_name": "string",
- "retention_policy": {
- "default_local_retention": 0,
- "default_remote_retention": 0,
- "local_max_snapshots": 0,
- "local_retention_period": 0,
- "local_retention_type": "NUM_SNAPSHOTS",
- "remote_max_snapshots": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_period": {
- "property1": 0,
- "property2": 0
}, - "remote_retention_type": {
- "property1": "NUM_SNAPSHOTS",
- "property2": "NUM_SNAPSHOTS"
}
}, - "rollup_schedule_uuid": "string",
- "start_times_in_usecs": [
- 0
], - "suspended": true,
- "timezone_offset": 0,
- "type": "SECONDLY",
- "user_start_time_in_usecs": 0,
- "values": [
- 0
]
}
], - "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "hybrid_schedules_count": 0,
- "marked_for_removal": true,
- "metro_avail": {
- "container": "string",
- "failure_handling": "NONE",
- "per_vm_consistency": true,
- "remote_site": "string",
- "role": "ACTIVE",
- "skip_clones_check": true,
- "status": "ENABLE_METRO_AVAIL_IN_PROGRESS",
- "storage_container": "string",
- "timeout": 10,
- "vm_agnostic_snapshots": true
}, - "min_snapshot_to_retain": 0,
- "name": "string",
- "next_snapshot_time_usecs": 0,
- "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "ongoing_replication_count": 0,
- "pending_replication_count": 0,
- "remote_site_names": [
- "string"
], - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "schedules_suspended": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "sync_replications": [
- {
- "id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "total_user_written_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
], - "vstore_id": 0
}
A remote cluster to be used as a DR site.
A Remote Site instance
object (create.dto.alerts.AlertSummaryDTO) | |
object (create.dto.dr.BandwidthPolicyDTO) This DTO describes bandwidth throttling policies for different time schedules | |
bandwidth_policy_enabled | boolean |
capabilities | Array of strings Items Enum: "BACKUP" "DISASTER_RECOVERY" "METRO_AVAILABILITY" "SUPPORT_DEDUPED_EXTENTS" "SUPPORT_VSPHERE" "SUPPORT_HYPERV" "SUPPORT_KVM" |
cloud_type | string Enum: "AWS" "AZURE" |
cluster_arch | string |
object (create.common.Address) | |
cluster_external_data_services_ipaddress | string |
cluster_id | integer <int64> |
cluster_incarnation_id | integer <int64> |
cluster_type | Array of strings Items Enum: "LIGHT_COMPUTE" "SINGLE_NODE_BACKUP" |
compression_enabled | boolean |
credential_name | string |
cvm_name | string |
object (create.dto.health.check.HealthSummaryDTO) | |
latency_in_usecs | integer <int64> |
marked_for_removal | boolean |
max_bps | integer <int32> |
metro_ready | boolean |
name | string |
object (create.dto.dr.NetworkMappingDTO) This DTO describes network mapping from source to destination cluster based on network uuids | |
proxy_enabled | boolean |
region | string |
remote_dr_external_subnet | string |
object (create.common.Address) | |
object | |
object | |
object | |
Array of objects (create.dto.dr.ReplicationLinkDTO) | |
ssh_enabled | boolean |
object | |
status | string Enum: "HANDSHAKING" "UNREACHABLE" "STRETCH_UNHEALTHY" "RELATIONSHIP_NOT_ESTABLISHED" "RELATIONSHIP_ESTABLISHED" "DEPLOYING" |
object | |
uuid | string |
object |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "alert_summary": { "alert_summaries": { "property1": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "property2": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } } }, "count": 0 }, "bandwidth_policy": { "bandwidth_configurations": [ { "bandwidth_limit": 0, "days_selected": 0, "end_time": 0, "schedule_uuid": "string", "start_time": 0 } ], "default_bandwidth_limit": 0, "policy_name": "string", "policy_uuid": "string" }, "bandwidth_policy_enabled": true, "capabilities": [ "string" ], "cloud_type": "AWS", "cluster_arch": "string", "cluster_external_data_services_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "cluster_external_data_services_ipaddress": "string", "cluster_id": 0, "cluster_incarnation_id": 0, "cluster_type": [ "string" ], "compression_enabled": true, "credential_name": "string", "cvm_name": "string", "health_summary": { "entity_type_summaries": [ { "checks_in_error": { "property1": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] }, "property2": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] } }, "detailed_check_summary": { "property1": {}, "property2": {} }, "entity_type": "PAGE", "filter_criteria": "string", "health_summary": { "property1": 0, "property2": 0 } } ], "health_check_summaries": { "property1": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 }, "property2": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 } }, "health_status": "Critical" }, "latency_in_usecs": 0, "marked_for_removal": true, "max_bps": 0, "metro_ready": true, "name": "string", "network_mapping": { "l2_network_mappings": [ { "dest_hypervisor_type": "string", "dest_network_name": "string", "src_hypervisor_type": "string", "src_network_name": "string" } ], "uuid": "string" }, "proxy_enabled": true, "region": "string", "remote_dr_external_subnet": "string", "remote_dr_external_subnet_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "remote_ip_address_ports": { "property1": 0, "property2": 0 }, "remote_ip_ports": { "property1": 0, "property2": 0 }, "remote_vstore_info": { "property1": { "is_protected": true, "is_stretch_empty": true, "max_capacity": 0, "metro_pd": "string", "used_physical_size": 0 }, "property2": { "is_protected": true, "is_stretch_empty": true, "max_capacity": 0, "metro_pd": "string", "used_physical_size": 0 } }, "replication_links": [ { "current_replicating_snapshot_id": "string", "current_replicating_snapshot_total_bytes": 0, "current_replicating_snapshot_transmitted_bytes": 0, "id": "string", "last_replication_end_time_in_usecs": 0, "last_replication_start_time_in_usecs": 0, "last_successful_replication_snapshot_id": "string", "protection_domain_name": "string", "remote_site_name": "string", "stats": { "property1": "string", "property2": "string" } } ], "ssh_enabled": true, "stats": { "property1": "string", "property2": "string" }, "status": "HANDSHAKING", "usage_stats": { "property1": "string", "property2": "string" }, "uuid": "string", "vstore_name_map": { "property1": "string", "property2": "string" } }'
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
Delete a Remote Site with the specified name from the cluster.
name required | string Name of the Remote Site |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
policy_uuid required | string Bandwidth policy Uuid |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/policies/{policy_uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Get a Remote Site with the specified name.
name required | string Name of the Remote Site |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
Get the list of backlogged/pending replications for the specified Remote Site in the cluster.
name required | string Name of the Remote Site |
protection_domain_names | Array of strings Names of Protection Domains |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/pending_replications \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "snapshot": {
- "consistency_groups": [
- "string"
], - "exclusive_usage_in_bytes": 0,
- "located_remote_site_name": "string",
- "missing_entities": [
- {
- "cg_name": "string",
- "entity_name": "string",
- "entity_type": "string"
}
], - "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "oob_schedule_ids": [
- 0
], - "protection_domain_name": "string",
- "remote_site_names": [
- "string"
], - "size_in_bytes": 0,
- "snapshot_create_time_usecs": 0,
- "snapshot_expiry_time_usecs": 0,
- "snapshot_id": "string",
- "snapshot_uuid": "string",
- "state": "EXPIRED",
- "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
]
}
}
]
Get the list of backlogged/pending replications in the cluster.
protection_domain_names | Array of strings Protection Domain Names |
remote_site_names | Array of strings Remote Site Names |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/pending_replications \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "snapshot": {
- "consistency_groups": [
- "string"
], - "exclusive_usage_in_bytes": 0,
- "located_remote_site_name": "string",
- "missing_entities": [
- {
- "cg_name": "string",
- "entity_name": "string",
- "entity_type": "string"
}
], - "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "oob_schedule_ids": [
- 0
], - "protection_domain_name": "string",
- "remote_site_names": [
- "string"
], - "size_in_bytes": 0,
- "snapshot_create_time_usecs": 0,
- "snapshot_expiry_time_usecs": 0,
- "snapshot_id": "string",
- "snapshot_uuid": "string",
- "state": "EXPIRED",
- "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
]
}
}
]
name required | string Name of the Remote Site |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
name required | string Name of the Remote Site |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of Remote Sites configured in the cluster.
names | Array of strings Remote Site names |
metro_compatible | boolean Remote Site stretchable |
full_details | boolean Remote cluster detail |
remoteVStores | Array of strings Remote container to fetch |
include_deleted | boolean Include deleted |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": { },
- "declared_annotations": { },
- "redefined_count": null
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": null,
- "super_interfaces": [ ],
- "superclass": null
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": null,
- "timestamp": null
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- null
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of all Snapshots created in Remote Sites.
count | integer <int32> Maximum number of DR Snapshots to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
full_details | boolean Whether to include consistency group / vm details |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/dr_snapshots \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "consistency_groups": [
- "string"
], - "exclusive_usage_in_bytes": 0,
- "located_remote_site_name": "string",
- "missing_entities": [
- {
- "cg_name": "string",
- "entity_name": "string",
- "entity_type": "string"
}
], - "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "oob_schedule_ids": [
- 0
], - "protection_domain_name": "string",
- "remote_site_names": [
- "string"
], - "size_in_bytes": 0,
- "snapshot_create_time_usecs": 0,
- "snapshot_expiry_time_usecs": 0,
- "snapshot_id": "string",
- "snapshot_uuid": "string",
- "state": "EXPIRED",
- "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of Snapshots created in a particular Remote Site.
name required | string Name of the Remote Site |
count | integer <int32> Maximum number of DR Snapshots to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
full_Details | boolean Whether to include consistency group / vm details |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/dr_snapshots \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "consistency_groups": [
- "string"
], - "exclusive_usage_in_bytes": 0,
- "located_remote_site_name": "string",
- "missing_entities": [
- {
- "cg_name": "string",
- "entity_name": "string",
- "entity_type": "string"
}
], - "nfs_files": [
- {
- "consistency_group": "string",
- "nfs_file_path": "string",
- "nfs_handle": 0
}
], - "oob_schedule_ids": [
- 0
], - "protection_domain_name": "string",
- "remote_site_names": [
- "string"
], - "size_in_bytes": 0,
- "snapshot_create_time_usecs": 0,
- "snapshot_expiry_time_usecs": 0,
- "snapshot_id": "string",
- "snapshot_uuid": "string",
- "state": "EXPIRED",
- "vms": [
- {
- "app_consistent_snapshots": true,
- "consistency_group": "string",
- "related_entity_uuids": [
- "string"
], - "vm_files": [
- "string"
], - "vm_handle": 0,
- "vm_id": "string",
- "vm_name": "string",
- "vm_power_state_on_recovery": "Powered Off",
- "vm_recoverability": [
- {
- "cerebro_error": "string",
- "reason": "string",
- "remote_site": "string"
}
]
}
], - "volume_groups": [
- {
- "consistency_group": "string",
- "name": "string",
- "nfs_file_paths": [
- "string"
], - "related_entity_uuids": [
- "string"
], - "volume_group_uuid": "string"
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
If start time and end time are included in the query string, then historical stats are retrieved. Otherwise, the latest stats are retrieved.
name required | string Name of the Remote Site |
metrics required | Array of strings List of metrics |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
interval_in_secs | integer <int32> Sampling interval of stats |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/stats \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "stats_specific_responses": [
- {
- "interval_in_secs": 0,
- "message": "string",
- "metric": "string",
- "start_time_in_usecs": 0,
- "successful": true,
- "values": [
- 0
]
}
]
}
name required | string |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/connection_status \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "message": "string",
- "name": "string",
- "status": true
}
remote_site | string Name of the Cluster |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/networks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "hypervisor_type": "string",
- "name": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Modify the configuration of the specified Remote Site.
A Remote Site instance
cluster_uuid | string |
object (patch.dto.dr.RemoteSiteDTO) remote-site | |
operation | string |
curl --request PATCH \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid": "string", "generic_dto": { "alert_summary": { "alert_summaries": { "property1": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "property2": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } } }, "count": 0 }, "bandwidth_policy": { "bandwidth_configurations": [ { "bandwidth_limit": 0, "days_selected": 0, "end_time": 0, "schedule_uuid": "string", "start_time": 0 } ], "default_bandwidth_limit": 0, "policy_name": "string", "policy_uuid": "string" }, "bandwidth_policy_enabled": true, "capabilities": [ "string" ], "cloud_type": "AWS", "cluster_arch": "string", "cluster_external_data_services_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "cluster_external_data_services_ipaddress": "string", "cluster_id": 0, "cluster_incarnation_id": 0, "cluster_type": [ "string" ], "compression_enabled": true, "credential_name": "string", "cvm_name": "string", "health_summary": { "entity_type_summaries": [ { "checks_in_error": { "property1": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] }, "property2": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] } }, "detailed_check_summary": { "property1": {}, "property2": {} }, "entity_type": "PAGE", "filter_criteria": "string", "health_summary": { "property1": 0, "property2": 0 } } ], "health_check_summaries": { "property1": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 }, "property2": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 } }, "health_status": "Critical" }, "latency_in_usecs": 0, "marked_for_removal": true, "max_bps": 0, "metro_ready": true, "name": "string", "network_mapping": { "l2_network_mappings": [ { "dest_hypervisor_type": "string", "dest_network_name": "string", "src_hypervisor_type": "string", "src_network_name": "string" } ], "uuid": "string" }, "proxy_enabled": true, "region": "string", "remote_dr_external_subnet": "string", "remote_dr_external_subnet_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "remote_ip_address_ports": { "property1": 0, "property2": 0 }, "remote_ip_ports": { "property1": 0, "property2": 0 }, "remote_vstore_info": { "property1": { "is_protected": true, "is_stretch_empty": true, "max_capacity": 0, "metro_pd": "string", "used_physical_size": 0 }, "property2": { "is_protected": true, "is_stretch_empty": true, "max_capacity": 0, "metro_pd": "string", "used_physical_size": 0 } }, "replication_links": [ { "current_replicating_snapshot_id": "string", "current_replicating_snapshot_total_bytes": 0, "current_replicating_snapshot_transmitted_bytes": 0, "id": "string", "last_replication_end_time_in_usecs": 0, "last_replication_start_time_in_usecs": 0, "last_successful_replication_snapshot_id": "string", "protection_domain_name": "string", "remote_site_name": "string", "stats": { "property1": "string", "property2": "string" } } ], "ssh_enabled": true, "stats": { "property1": "string", "property2": "string" }, "status": "HANDSHAKING", "usage_stats": { "property1": "string", "property2": "string" }, "uuid": "string", "vstore_name_map": { "property1": "string", "property2": "string" } }, "operation": "string" }'
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
name required | string |
object (create.common.Address) |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/add_remote_ip \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } }'
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
name required | string |
value | boolean |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/compression \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": true }'
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
name required | string |
dr_snapshot_id | string |
pd_name | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/dr_snapshots/download_snapshot \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "dr_snapshot_id": "string", "pd_name": "string" }'
{- "value": true
}
name required | string |
object |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/dr_snapshots/remove_list \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "dr_snapshot_ids_map": { "property1": [ "string" ], "property2": [ "string" ] } }'
{- "value": true
}
name required | string |
value | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/map_vstore \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": "string" }'
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
name required | string |
value | integer <int32> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/max_bandwidth \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": 0 }'
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
name required | string |
value | boolean |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/proxy \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": true }'
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
name required | string |
object (create.common.Address) |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/remove_remote_ip \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } }'
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
name required | string |
value | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites/{name}/unmap_vstore \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": "string" }'
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
Update the configuration of the specified Remote Site.
A Remote Site instance
object (update.dto.alerts.AlertSummaryDTO) | |
object (update.dto.dr.BandwidthPolicyDTO) This DTO describes bandwidth throttling policies for different time schedules | |
bandwidth_policy_enabled | boolean |
capabilities | Array of strings Items Enum: "BACKUP" "DISASTER_RECOVERY" "METRO_AVAILABILITY" "SUPPORT_DEDUPED_EXTENTS" "SUPPORT_VSPHERE" "SUPPORT_HYPERV" "SUPPORT_KVM" |
cloud_type | string Enum: "AWS" "AZURE" |
cluster_arch | string |
object (update.common.Address) | |
cluster_external_data_services_ipaddress | string |
cluster_id | integer <int64> |
cluster_incarnation_id | integer <int64> |
cluster_type | Array of strings Items Enum: "LIGHT_COMPUTE" "SINGLE_NODE_BACKUP" |
compression_enabled | boolean |
credential_name | string |
cvm_name | string |
object (update.dto.health.check.HealthSummaryDTO) | |
latency_in_usecs | integer <int64> |
marked_for_removal | boolean |
max_bps | integer <int32> |
metro_ready | boolean |
name | string |
object (update.dto.dr.NetworkMappingDTO) This DTO describes network mapping from source to destination cluster based on network uuids | |
proxy_enabled | boolean |
region | string |
remote_dr_external_subnet | string |
object (update.common.Address) | |
object | |
object | |
object | |
Array of objects (update.dto.dr.ReplicationLinkDTO) | |
ssh_enabled | boolean |
object | |
status | string Enum: "HANDSHAKING" "UNREACHABLE" "STRETCH_UNHEALTHY" "RELATIONSHIP_NOT_ESTABLISHED" "RELATIONSHIP_ESTABLISHED" "DEPLOYING" |
object | |
uuid | string |
object |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/remote_sites \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "alert_summary": { "alert_summaries": { "property1": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "property2": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } } }, "count": 0 }, "bandwidth_policy": { "bandwidth_configurations": [ { "bandwidth_limit": 0, "days_selected": 0, "end_time": 0, "schedule_uuid": "string", "start_time": 0 } ], "default_bandwidth_limit": 0, "policy_name": "string", "policy_uuid": "string" }, "bandwidth_policy_enabled": true, "capabilities": [ "string" ], "cloud_type": "AWS", "cluster_arch": "string", "cluster_external_data_services_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "cluster_external_data_services_ipaddress": "string", "cluster_id": 0, "cluster_incarnation_id": 0, "cluster_type": [ "string" ], "compression_enabled": true, "credential_name": "string", "cvm_name": "string", "health_summary": { "entity_type_summaries": [ { "checks_in_error": { "property1": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] }, "property2": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] } }, "detailed_check_summary": { "property1": {}, "property2": {} }, "entity_type": "PAGE", "filter_criteria": "string", "health_summary": { "property1": 0, "property2": 0 } } ], "health_check_summaries": { "property1": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 }, "property2": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 } }, "health_status": "Critical" }, "latency_in_usecs": 0, "marked_for_removal": true, "max_bps": 0, "metro_ready": true, "name": "string", "network_mapping": { "l2_network_mappings": [ { "dest_hypervisor_type": "string", "dest_network_name": "string", "src_hypervisor_type": "string", "src_network_name": "string" } ], "uuid": "string" }, "proxy_enabled": true, "region": "string", "remote_dr_external_subnet": "string", "remote_dr_external_subnet_address": { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" }, "remote_ip_address_ports": { "property1": 0, "property2": 0 }, "remote_ip_ports": { "property1": 0, "property2": 0 }, "remote_vstore_info": { "property1": { "is_protected": true, "is_stretch_empty": true, "max_capacity": 0, "metro_pd": "string", "used_physical_size": 0 }, "property2": { "is_protected": true, "is_stretch_empty": true, "max_capacity": 0, "metro_pd": "string", "used_physical_size": 0 } }, "replication_links": [ { "current_replicating_snapshot_id": "string", "current_replicating_snapshot_total_bytes": 0, "current_replicating_snapshot_transmitted_bytes": 0, "id": "string", "last_replication_end_time_in_usecs": 0, "last_replication_start_time_in_usecs": 0, "last_successful_replication_snapshot_id": "string", "protection_domain_name": "string", "remote_site_name": "string", "stats": { "property1": "string", "property2": "string" } } ], "ssh_enabled": true, "stats": { "property1": "string", "property2": "string" }, "status": "HANDSHAKING", "usage_stats": { "property1": "string", "property2": "string" }, "uuid": "string", "vstore_name_map": { "property1": "string", "property2": "string" } }'
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "bandwidth_policy": {
- "bandwidth_configurations": [
- {
- "bandwidth_limit": 0,
- "days_selected": 0,
- "end_time": 0,
- "schedule_uuid": "string",
- "start_time": 0
}
], - "default_bandwidth_limit": 0,
- "policy_name": "string",
- "policy_uuid": "string"
}, - "bandwidth_policy_enabled": true,
- "capabilities": [
- "BACKUP"
], - "cloud_type": "AWS",
- "cluster_arch": "string",
- "cluster_external_data_services_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "cluster_external_data_services_ipaddress": "string",
- "cluster_id": 0,
- "cluster_incarnation_id": 0,
- "cluster_type": [
- "LIGHT_COMPUTE"
], - "compression_enabled": true,
- "credential_name": "string",
- "cvm_name": "string",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "latency_in_usecs": 0,
- "marked_for_removal": true,
- "max_bps": 0,
- "metro_ready": true,
- "name": "string",
- "network_mapping": {
- "l2_network_mappings": [
- {
- "dest_hypervisor_type": "string",
- "dest_network_name": "string",
- "src_hypervisor_type": "string",
- "src_network_name": "string"
}
], - "uuid": "string"
}, - "proxy_enabled": true,
- "region": "string",
- "remote_dr_external_subnet": "string",
- "remote_dr_external_subnet_address": {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": { },
- "property2": { }
}, - "declared_annotations": {
- "property1": { },
- "property2": { }
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- { }
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}, - "remote_ip_address_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_ip_ports": {
- "property1": 0,
- "property2": 0
}, - "remote_vstore_info": {
- "property1": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}, - "property2": {
- "is_protected": true,
- "is_stretch_empty": true,
- "max_capacity": 0,
- "metro_pd": "string",
- "used_physical_size": 0
}
}, - "replication_links": [
- {
- "current_replicating_snapshot_id": "string",
- "current_replicating_snapshot_total_bytes": 0,
- "current_replicating_snapshot_transmitted_bytes": 0,
- "id": "string",
- "last_replication_end_time_in_usecs": 0,
- "last_replication_start_time_in_usecs": 0,
- "last_successful_replication_snapshot_id": "string",
- "protection_domain_name": "string",
- "remote_site_name": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}
}
], - "ssh_enabled": true,
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "status": "HANDSHAKING",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "vstore_name_map": {
- "property1": "string",
- "property2": "string"
}
}
Clone a Snapshot. If a UUID is specified for the cloned snapshot, then the operation will be idempotent. If overrideNetworkConfig is set to true in the clone spec, then the source snapshot s network configuration is overridden by one specified in the nic list. If false, the clone will inherit its basic network configuration from the source, minus MAC and IP address. This is also an asynchronous operation that results in the creation of a task object.This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
uuid required | string Id of the Snapshot |
Clone a Snapshot
Array of objects (create.dto.acropolis.VMCloneSpecDTO) | |
uuid | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snapshots/{uuid}/clone \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "spec_list": [ { "boot_config": { "boot_device_order": [ "string" ], "boot_device_type": "CDROM", "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "hardware_virtualization": true, "mac_addr": "string", "secure_boot": true, "uefi_boot": true }, "clone_affinity": true, "memory_mb": 0, "name": "string", "num_cores_per_vcpu": 0, "num_vcpus": 0, "override_network_config": true, "uuid": "string", "vm_nics": [ { "adapter_type": "E1000", "ip_address": "string", "ip_addresses": [ "string" ], "is_connected": true, "mac_address": "string", "model": "string", "network_uuid": "string", "nic_uuid": "string", "port_id": "string", "request_ip": true, "requested_ip_address": "string", "vlan_mode": "Access" } ] } ], "uuid": "string" }'
{- "task_uuid": "string"
}
Create Virtual Machine snapshots. If a UUID is specified for the snapshot, this operation will be idempotent. If multiple VMs are specified, all of their configurations and disks will fall into the same consistency group. Since this operation requires the coordination of multiple resources, it should not be abused by specifying more than several VMs at a time. Snapshots are crash-consistent. They do not include the VM s current memory image, only the VM configuration and its disk contents. The snapshot is taken atomically across all of a VM s configuration and disks to ensure consistency. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
Create a snapshot
Array of objects (create.dto.acropolis.SnapshotSpecDTO) |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snapshots \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "snapshot_specs": [ { "snapshot_name": "string", "uuid": "string", "vm_logical_timestamp": 0, "vm_uuid": "string" } ] }'
{- "task_uuid": "string"
}
Delete a snapshot. This operation is idempotent. The logical timestamp can optionally be provided for consistency. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the snapshot logical timestamp. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
uuid required | string Id of the Snapshot |
logical_timestamp | integer <int64> Logical timestamp |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snapshots/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "task_uuid": "string"
}
Get a list of snapshots in a cluster.
vm_uuid | string Uuid of the vm |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snapshots \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "created_time": 0,
- "deleted": true,
- "group_uuid": "string",
- "logical_timestamp": 0,
- "snapshot_name": "string",
- "uuid": "string",
- "vm_create_spec": {
- "allow_live_migrate": true,
- "boot": {
- "boot_device_order": [
- "CDROM"
], - "boot_device_type": "CDROM",
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "hardware_virtualization": true,
- "mac_addr": "string",
- "secure_boot": true,
- "uefi_boot": true
}, - "cbr_not_capable_reason": "string",
- "clear_affinity": true,
- "description": "string",
- "gpus_assigned": true,
- "guest_driver_version": "string",
- "guest_os": "string",
- "ha_priority": 0,
- "host_uuid": "string",
- "machine_type": "PC",
- "memory_mb": 0,
- "memory_reservation_mb": 0,
- "name": "string",
- "num_cores_per_vcpu": 0,
- "num_vcpus": 0,
- "power_state": "UNKNOWN",
- "serial_ports": [
- {
- "index": 0,
- "type": "NULL"
}
], - "storage_container_uuid": "string",
- "timezone": "string",
- "tools_installer_mounted": true,
- "tools_running_status": "UNKNOWN",
- "uuid": "string",
- "vcpu_reservation_hz": 0,
- "vm_customization_config": {
- "datasource_type": "CONFIG_DRIVE_V2",
- "files_to_inject_list": [
- {
- "destination_path": "string",
- "source_path": "string"
}
], - "fresh_install": true,
- "userdata": "string",
- "userdata_path": "string"
}, - "vm_disk_info": [
- {
- "datasource_uuid": "string",
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "flash_mode_enabled": true,
- "is_cdrom": true,
- "is_empty": true,
- "is_hot_remove_enabled": true,
- "is_scsi_passthrough": true,
- "is_thin_provisioned": true,
- "shared": true,
- "size": 0,
- "source_disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "storage_container_uuid": "string"
}
], - "vm_disks": [
- {
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "flash_mode_enabled": true,
- "is_cdrom": true,
- "is_empty": true,
- "is_scsi_pass_through": true,
- "is_thin_provisioned": true,
- "vm_disk_clone": {
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "minimum_size": 0,
- "snapshot_group_uuid": "string",
- "storage_container_uuid": "string"
}, - "vm_disk_clone_external": {
- "external_disk_url": "string",
- "size": 0,
- "storage_container_uuid": "string"
}, - "vm_disk_create": {
- "size": 0,
- "storage_container_uuid": "string"
}, - "vm_disk_passthru_external": {
- "external_disk_url": "string",
- "storage_container_uuid": "string"
}
}
], - "vm_features": {
- "property1": true,
- "property2": true
}, - "vm_gpus": [
- {
- "assignable": true,
- "device_id": 0,
- "device_name": "string",
- "fraction": 0,
- "frame_buffer_size_bytes": 0,
- "gpu_mode": "UNUSED",
- "gpu_profile": "string",
- "gpu_type": "PASS_THROUGH_GRAPHICS",
- "gpu_vendor": "NVIDIA",
- "guest_driver_version": "string",
- "in_use": true,
- "licenses": [
- "string"
], - "max_instances_per_vm": 0,
- "max_resolution": "string",
- "num_virtual_display_heads": 0,
- "numa_node": 0,
- "sbdf": "string",
- "vm_uuids": [
- "string"
]
}
], - "vm_logical_timestamp": 0,
- "vm_nics": [
- {
- "adapter_type": "E1000",
- "ip_address": "string",
- "ip_addresses": [
- "string"
], - "is_connected": true,
- "mac_address": "string",
- "model": "string",
- "network_uuid": "string",
- "nic_uuid": "string",
- "port_id": "string",
- "request_ip": true,
- "requested_ip_address": "string",
- "vlan_mode": "Access"
}
]
}, - "vm_create_specification": {
- "boot_config": {
- "boot_device_order": [
- "CDROM"
], - "boot_device_type": "CDROM",
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "hardware_virtualization": true,
- "mac_addr": "string",
- "secure_boot": true,
- "uefi_boot": true
}, - "container_uuid": "string",
- "description": "string",
- "ha_priority": 0,
- "host_id": "string",
- "hypervisor_type": "ACROPOLIS",
- "memory_mb": 0,
- "memory_reservation_mb": 0,
- "name": "string",
- "num_cores_per_vcpu": 0,
- "num_vcpus": 0,
- "timezone": "string",
- "uuid": "string",
- "vcpu_reservation_hz": 0,
- "vm_customization_config": {
- "datasource_type": "CONFIG_DRIVE_V2",
- "files_to_inject_list": [
- {
- "destination_path": "string",
- "source_path": "string"
}
], - "fresh_install": true,
- "userdata": "string",
- "userdata_path": "string"
}, - "vm_disks": [
- {
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "is_cdrom": true,
- "is_empty": true,
- "is_scsi_pass_through": true,
- "is_thin_provisioned": true,
- "vm_disk_clone": {
- "container_uuid": "string",
- "image_path": "string",
- "minimum_size": 0,
- "minimum_size_mb": 0,
- "ndfs_filepath": "string",
- "snapshot_group_id": "string",
- "vm_disk_uuid": "string",
- "vmdisk_uuid": "string"
}, - "vm_disk_create": {
- "container_id": 0,
- "container_name": "string",
- "container_uuid": "string",
- "size": 0,
- "size_mb": 0
}
}
], - "vm_gpus": [
- {
- "assignable": true,
- "device_id": 0,
- "device_name": "string",
- "fraction": 0,
- "frame_buffer_size_bytes": 0,
- "gpu_mode": "UNUSED",
- "gpu_profile": "string",
- "gpu_type": "PASS_THROUGH_GRAPHICS",
- "gpu_vendor": "NVIDIA",
- "guest_driver_version": "string",
- "in_use": true,
- "licenses": [
- "string"
], - "max_instances_per_vm": 0,
- "max_resolution": "string",
- "num_virtual_display_heads": 0,
- "numa_node": 0,
- "sbdf": "string",
- "vm_uuids": [
- "string"
]
}
], - "vm_nics": [
- {
- "adapter_type": "E1000",
- "ip_address": "string",
- "ip_addresses": [
- "string"
], - "is_connected": true,
- "mac_address": "string",
- "model": "string",
- "network_uuid": "string",
- "nic_uuid": "string",
- "port_id": "string",
- "request_ip": true,
- "requested_ip_address": "string",
- "vlan_mode": "Access"
}
]
}, - "vm_uuid": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get details of a specified snapshot.
uuid required | string Id of the Snapshot |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snapshots/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "created_time": 0,
- "deleted": true,
- "group_uuid": "string",
- "logical_timestamp": 0,
- "snapshot_name": "string",
- "uuid": "string",
- "vm_create_spec": {
- "allow_live_migrate": true,
- "boot": {
- "boot_device_order": [
- "CDROM"
], - "boot_device_type": "CDROM",
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "hardware_virtualization": true,
- "mac_addr": "string",
- "secure_boot": true,
- "uefi_boot": true
}, - "cbr_not_capable_reason": "string",
- "clear_affinity": true,
- "description": "string",
- "gpus_assigned": true,
- "guest_driver_version": "string",
- "guest_os": "string",
- "ha_priority": 0,
- "host_uuid": "string",
- "machine_type": "PC",
- "memory_mb": 0,
- "memory_reservation_mb": 0,
- "name": "string",
- "num_cores_per_vcpu": 0,
- "num_vcpus": 0,
- "power_state": "UNKNOWN",
- "serial_ports": [
- {
- "index": 0,
- "type": "NULL"
}
], - "storage_container_uuid": "string",
- "timezone": "string",
- "tools_installer_mounted": true,
- "tools_running_status": "UNKNOWN",
- "uuid": "string",
- "vcpu_reservation_hz": 0,
- "vm_customization_config": {
- "datasource_type": "CONFIG_DRIVE_V2",
- "files_to_inject_list": [
- {
- "destination_path": "string",
- "source_path": "string"
}
], - "fresh_install": true,
- "userdata": "string",
- "userdata_path": "string"
}, - "vm_disk_info": [
- {
- "datasource_uuid": "string",
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "flash_mode_enabled": true,
- "is_cdrom": true,
- "is_empty": true,
- "is_hot_remove_enabled": true,
- "is_scsi_passthrough": true,
- "is_thin_provisioned": true,
- "shared": true,
- "size": 0,
- "source_disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "storage_container_uuid": "string"
}
], - "vm_disks": [
- {
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "flash_mode_enabled": true,
- "is_cdrom": true,
- "is_empty": true,
- "is_scsi_pass_through": true,
- "is_thin_provisioned": true,
- "vm_disk_clone": {
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "minimum_size": 0,
- "snapshot_group_uuid": "string",
- "storage_container_uuid": "string"
}, - "vm_disk_clone_external": {
- "external_disk_url": "string",
- "size": 0,
- "storage_container_uuid": "string"
}, - "vm_disk_create": {
- "size": 0,
- "storage_container_uuid": "string"
}, - "vm_disk_passthru_external": {
- "external_disk_url": "string",
- "storage_container_uuid": "string"
}
}
], - "vm_features": {
- "property1": true,
- "property2": true
}, - "vm_gpus": [
- {
- "assignable": true,
- "device_id": 0,
- "device_name": "string",
- "fraction": 0,
- "frame_buffer_size_bytes": 0,
- "gpu_mode": "UNUSED",
- "gpu_profile": "string",
- "gpu_type": "PASS_THROUGH_GRAPHICS",
- "gpu_vendor": "NVIDIA",
- "guest_driver_version": "string",
- "in_use": true,
- "licenses": [
- "string"
], - "max_instances_per_vm": 0,
- "max_resolution": "string",
- "num_virtual_display_heads": 0,
- "numa_node": 0,
- "sbdf": "string",
- "vm_uuids": [
- "string"
]
}
], - "vm_logical_timestamp": 0,
- "vm_nics": [
- {
- "adapter_type": "E1000",
- "ip_address": "string",
- "ip_addresses": [
- "string"
], - "is_connected": true,
- "mac_address": "string",
- "model": "string",
- "network_uuid": "string",
- "nic_uuid": "string",
- "port_id": "string",
- "request_ip": true,
- "requested_ip_address": "string",
- "vlan_mode": "Access"
}
]
}, - "vm_create_specification": {
- "boot_config": {
- "boot_device_order": [
- "CDROM"
], - "boot_device_type": "CDROM",
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "hardware_virtualization": true,
- "mac_addr": "string",
- "secure_boot": true,
- "uefi_boot": true
}, - "container_uuid": "string",
- "description": "string",
- "ha_priority": 0,
- "host_id": "string",
- "hypervisor_type": "ACROPOLIS",
- "memory_mb": 0,
- "memory_reservation_mb": 0,
- "name": "string",
- "num_cores_per_vcpu": 0,
- "num_vcpus": 0,
- "timezone": "string",
- "uuid": "string",
- "vcpu_reservation_hz": 0,
- "vm_customization_config": {
- "datasource_type": "CONFIG_DRIVE_V2",
- "files_to_inject_list": [
- {
- "destination_path": "string",
- "source_path": "string"
}
], - "fresh_install": true,
- "userdata": "string",
- "userdata_path": "string"
}, - "vm_disks": [
- {
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "is_cdrom": true,
- "is_empty": true,
- "is_scsi_pass_through": true,
- "is_thin_provisioned": true,
- "vm_disk_clone": {
- "container_uuid": "string",
- "image_path": "string",
- "minimum_size": 0,
- "minimum_size_mb": 0,
- "ndfs_filepath": "string",
- "snapshot_group_id": "string",
- "vm_disk_uuid": "string",
- "vmdisk_uuid": "string"
}, - "vm_disk_create": {
- "container_id": 0,
- "container_name": "string",
- "container_uuid": "string",
- "size": 0,
- "size_mb": 0
}
}
], - "vm_gpus": [
- {
- "assignable": true,
- "device_id": 0,
- "device_name": "string",
- "fraction": 0,
- "frame_buffer_size_bytes": 0,
- "gpu_mode": "UNUSED",
- "gpu_profile": "string",
- "gpu_type": "PASS_THROUGH_GRAPHICS",
- "gpu_vendor": "NVIDIA",
- "guest_driver_version": "string",
- "in_use": true,
- "licenses": [
- "string"
], - "max_instances_per_vm": 0,
- "max_resolution": "string",
- "num_virtual_display_heads": 0,
- "numa_node": 0,
- "sbdf": "string",
- "vm_uuids": [
- "string"
]
}
], - "vm_nics": [
- {
- "adapter_type": "E1000",
- "ip_address": "string",
- "ip_addresses": [
- "string"
], - "is_connected": true,
- "mac_address": "string",
- "model": "string",
- "network_uuid": "string",
- "nic_uuid": "string",
- "port_id": "string",
- "request_ip": true,
- "requested_ip_address": "string",
- "vlan_mode": "Access"
}
]
}, - "vm_uuid": "string"
}
Add SNMP Transports to the existing SNMP Transports.
List of SNMP Transports
port | integer <int32> [ 0 .. 65536 ] |
transport_protocol | string Enum: "TCP" "TCP_6" "UDP" "UDP_6" |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/add_transports \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "port": 65536,
- "transport_protocol": "TCP"
}
]
Add SNMP Trap to the cluster.
An SNMP Trap instance
community_string | string |
engine_id | string |
inform | boolean |
object (org.slf4j.Logger) | |
port | integer <int32> [ 0 .. 65536 ] |
receiver_name | string |
transport_protocol | string Enum: "TCP" "TCP_6" "UDP" "UDP_6" |
trap_address | string |
trap_username | string |
version | string Enum: "SNMPv2C" "SNMPv3" |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/traps \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "community_string": "string", "engine_id": "string", "inform": true, "log": { "root_logger_name": "string" }, "port": 0, "receiver_name": "string", "transport_protocol": "TCP", "trap_address": "string", "trap_username": "string", "version": "SNMPv2C" }'
{- "community_string": "string",
- "engine_id": "string",
- "inform": true,
- "log": {
- "root_logger_name": "string"
}, - "port": 65536,
- "receiver_name": "string",
- "transport_protocol": "TCP",
- "trap_address": "string",
- "trap_username": "string",
- "version": "SNMPv2C"
}
Add SNMP User to the cluster.
An SNMP User instance
auth_key | string |
auth_type | string Value: "SHA" |
priv_key | string |
priv_type | string Value: "AES" |
username | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/users \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "auth_key": "string", "auth_type": "SHA", "priv_key": "string", "priv_type": "AES", "username": "string" }'
{- "auth_key": "string",
- "auth_type": "SHA",
- "priv_key": "string",
- "priv_type": "AES",
- "username": "string"
}
Delete SNMP Trap with the specified address
trap_address required | string Address of the SNMP Trap |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/traps/{trap_address} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Delete SNMP User with the specified name.
username required | string Name of the SNMP User |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/users/{username} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Edit the specified SNMP Trap.
An SNMP Trap instance
community_string | string |
engine_id | string |
inform | boolean |
object (org.slf4j.Logger) | |
port | integer <int32> [ 0 .. 65536 ] |
receiver_name | string |
transport_protocol | string Enum: "TCP" "TCP_6" "UDP" "UDP_6" |
trap_address | string |
trap_username | string |
version | string Enum: "SNMPv2C" "SNMPv3" |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/traps \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "community_string": "string", "engine_id": "string", "inform": true, "log": { "root_logger_name": "string" }, "port": 0, "receiver_name": "string", "transport_protocol": "TCP", "trap_address": "string", "trap_username": "string", "version": "SNMPv2C" }'
{- "community_string": "string",
- "engine_id": "string",
- "inform": true,
- "log": {
- "root_logger_name": "string"
}, - "port": 65536,
- "receiver_name": "string",
- "transport_protocol": "TCP",
- "trap_address": "string",
- "trap_username": "string",
- "version": "SNMPv2C"
}
Edit the specified SNMP User.
An SNMP User instance
auth_key | string |
auth_type | string Value: "SHA" |
priv_key | string |
priv_type | string Value: "AES" |
username | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/users \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "auth_key": "string", "auth_type": "SHA", "priv_key": "string", "priv_type": "AES", "username": "string" }'
{- "auth_key": "string",
- "auth_type": "SHA",
- "priv_key": "string",
- "priv_type": "AES",
- "username": "string"
}
Enable/Disable SNMP configuration in the cluster.
Enable SNMP Status
value | boolean |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/status \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "value": true }'
{- "enabled": true,
- "snmp_transports": [
- {
- "port": 65536,
- "transport_protocol": "TCP"
}
], - "snmp_traps": [
- {
- "community_string": "string",
- "engine_id": "string",
- "inform": true,
- "log": {
- "root_logger_name": "string"
}, - "port": 65536,
- "receiver_name": "string",
- "transport_protocol": "TCP",
- "trap_address": "string",
- "trap_username": "string",
- "version": "SNMPv2C"
}
], - "snmp_users": [
- {
- "auth_key": "string",
- "auth_type": "SHA",
- "priv_key": "string",
- "priv_type": "AES",
- "username": "string"
}
]
}
Get the complete SNMP configuration including Users, Transports and Traps configured in the cluster.
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "enabled": true,
- "snmp_transports": [
- {
- "port": 65536,
- "transport_protocol": "TCP"
}
], - "snmp_traps": [
- {
- "community_string": "string",
- "engine_id": "string",
- "inform": true,
- "log": {
- "root_logger_name": "string"
}, - "port": 65536,
- "receiver_name": "string",
- "transport_protocol": "TCP",
- "trap_address": "string",
- "trap_username": "string",
- "version": "SNMPv2C"
}
], - "snmp_users": [
- {
- "auth_key": "string",
- "auth_type": "SHA",
- "priv_key": "string",
- "priv_type": "AES",
- "username": "string"
}
]
}
Get SNMP Trap with the specified address.
trap_address required | string Address of the SNMP Trap |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/traps/{trap_address} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "community_string": "string",
- "engine_id": "string",
- "inform": true,
- "log": {
- "root_logger_name": "string"
}, - "port": 65536,
- "receiver_name": "string",
- "transport_protocol": "TCP",
- "trap_address": "string",
- "trap_username": "string",
- "version": "SNMPv2C"
}
Get SNMP User with the specified name.
username required | string Name of the SNMP User |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/users/{username} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "auth_key": "string",
- "auth_type": "SHA",
- "priv_key": "string",
- "priv_type": "AES",
- "username": "string"
}
Get the list of SNMP Transports configured in the cluster.
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/transports \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "port": 65536,
- "transport_protocol": "TCP"
}
]
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/traps \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "community_string": "string",
- "engine_id": "string",
- "inform": true,
- "log": {
- "root_logger_name": "string"
}, - "port": 65536,
- "receiver_name": "string",
- "transport_protocol": "TCP",
- "trap_address": "string",
- "trap_username": "string",
- "version": "SNMPv2C"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/users \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "auth_key": "string",
- "auth_type": "SHA",
- "priv_key": "string",
- "priv_type": "AES",
- "username": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/status \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Modify the specified SNMP Trap.
An SNMP Trap instance
cluster_uuid | string |
object (patch.dto.appliance.configuration.SnmpTrapDTO) | |
operation | string |
curl --request PATCH \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/traps \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid": "string", "generic_dto": { "community_string": "string", "engine_id": "string", "inform": true, "log": { "root_logger_name": "string" }, "port": 0, "receiver_name": "string", "transport_protocol": "TCP", "trap_address": "string", "trap_username": "string", "version": "SNMPv2C" }, "operation": "string" }'
{- "community_string": "string",
- "engine_id": "string",
- "inform": true,
- "log": {
- "root_logger_name": "string"
}, - "port": 65536,
- "receiver_name": "string",
- "transport_protocol": "TCP",
- "trap_address": "string",
- "trap_username": "string",
- "version": "SNMPv2C"
}
Modify the specified SNMP User.
An SNMP User instance
cluster_uuid | string |
object (patch.dto.appliance.configuration.SnmpUserDTO) | |
operation | string |
curl --request PATCH \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/users \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid": "string", "generic_dto": { "auth_key": "string", "auth_type": "SHA", "priv_key": "string", "priv_type": "AES", "username": "string" }, "operation": "string" }'
{- "auth_key": "string",
- "auth_type": "SHA",
- "priv_key": "string",
- "priv_type": "AES",
- "username": "string"
}
Remove SNMP Transports from the existing SNMP Transports.
List of SNMP Transports
port | integer <int32> [ 0 .. 65536 ] |
transport_protocol | string Enum: "TCP" "TCP_6" "UDP" "UDP_6" |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/snmp/remove_transports \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "port": 65536,
- "transport_protocol": "TCP"
}
]
Add a Storage Container to the cluster.
A Storage Container instance
advertised_capacity | integer <int64> |
affinity_host_uuid | string |
object (create.dto.alerts.AlertSummaryDTO) | |
cluster_uuid | string |
compression_delay_in_secs | integer <int32> |
compression_enabled | boolean |
container_uuid | string |
object | |
enable_software_encryption | boolean |
encrypted | boolean |
erasure_code | string |
erasure_code_delay_secs | integer <int32> |
finger_print_on_write | string Enum: "NONE" "OFF" "ON" |
object (create.dto.health.check.HealthSummaryDTO) | |
id | string |
ilm_policy | string |
inline_ec_enabled | boolean |
is_nutanix_managed | boolean |
object | |
marked_for_removal | boolean |
max_capacity | integer <int64> |
max_ec_info_strip_size | integer <int32> |
name | string |
nfs_whitelist | Array of strings |
Array of objects (create.common.Address) | |
nfs_whitelist_inherited | boolean |
on_disk_dedup | string Enum: "NONE" "OFF" "POST_PROCESS" |
oplog_replication_factor | integer <int32> |
prefer_higher_ecfault_domain | boolean |
random_io_preference | Array of strings |
replication_factor | integer <int32> |
seq_io_preference | Array of strings |
software_inline_ec_type | string Enum: "ContainerDTO.SoftwareInlineEcType(type same-vdisk-strips)" "ContainerDTO.SoftwareInlineEcType(type cross-vdisk-strips)" |
object | |
storage_container_uuid | string |
storage_pool_id | string |
storage_pool_uuid | string |
total_explicit_reserved_capacity | integer <int64> |
total_implicit_reserved_capacity | integer <int64> |
object | |
vstore_name_list | Array of strings |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "advertised_capacity": 0, "affinity_host_uuid": "string", "alert_summary": { "alert_summaries": { "property1": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "property2": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } } }, "count": 0 }, "cluster_uuid": "string", "compression_delay_in_secs": 0, "compression_enabled": true, "container_uuid": "string", "down_migrate_times_in_secs": { "property1": 0, "property2": 0 }, "enable_software_encryption": true, "encrypted": true, "erasure_code": "string", "erasure_code_delay_secs": 0, "finger_print_on_write": "NONE", "health_summary": { "entity_type_summaries": [ { "checks_in_error": { "property1": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] }, "property2": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] } }, "detailed_check_summary": { "property1": {}, "property2": {} }, "entity_type": "PAGE", "filter_criteria": "string", "health_summary": { "property1": 0, "property2": 0 } } ], "health_check_summaries": { "property1": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 }, "property2": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 } }, "health_status": "Critical" }, "id": "string", "ilm_policy": "string", "inline_ec_enabled": true, "is_nutanix_managed": true, "mapped_remote_containers": { "property1": "string", "property2": "string" }, "marked_for_removal": true, "max_capacity": 0, "max_ec_info_strip_size": 0, "name": "string", "nfs_whitelist": [ "string" ], "nfs_whitelist_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "nfs_whitelist_inherited": true, "on_disk_dedup": "NONE", "oplog_replication_factor": 0, "prefer_higher_ecfault_domain": true, "random_io_preference": [ "string" ], "replication_factor": 0, "seq_io_preference": [ "string" ], "software_inline_ec_type": "ContainerDTO.SoftwareInlineEcType(type same-vdisk-strips)", "stats": { "property1": "string", "property2": "string" }, "storage_container_uuid": "string", "storage_pool_id": "string", "storage_pool_uuid": "string", "total_explicit_reserved_capacity": 0, "total_implicit_reserved_capacity": 0, "usage_stats": { "property1": "string", "property2": "string" }, "vstore_name_list": [ "string" ] }'
{- "value": true
}
Add an NFS Datastore.
Add request
container_name | string |
datastore_name | string |
node_ids | Array of strings |
node_uuids | Array of strings |
read_only | boolean |
storage_container_name | string |
target_path | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers/datastores/add_datastore \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "container_name": "string", "datastore_name": "string", "node_ids": [ "string" ], "node_uuids": [ "string" ], "read_only": true, "storage_container_name": "string", "target_path": "string" }'
{- "node_specific_status": [
- {
- "capacity": 0,
- "free_space": 0,
- "message": "string",
- "node_id": "string",
- "node_ip_address": "string",
- "node_uuid": "string",
- "successful": true
}
]
}
Delete a Storage Container with the specified uuid from the cluster.
uuid required | string Uuid of the Storage Container |
ignore_small_files | boolean Ignore small file |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
Get a Storage Container with the specified uuid.
uuid required | string Uuid of the Storage Container |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "advertised_capacity": 0,
- "affinity_host_uuid": "string",
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "cluster_uuid": "string",
- "compression_delay_in_secs": 0,
- "compression_enabled": true,
- "container_uuid": "string",
- "down_migrate_times_in_secs": {
- "property1": 0,
- "property2": 0
}, - "enable_software_encryption": true,
- "encrypted": true,
- "erasure_code": "string",
- "erasure_code_delay_secs": 0,
- "finger_print_on_write": "NONE",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "id": "string",
- "ilm_policy": "string",
- "inline_ec_enabled": true,
- "is_nutanix_managed": true,
- "mapped_remote_containers": {
- "property1": "string",
- "property2": "string"
}, - "marked_for_removal": true,
- "max_capacity": 0,
- "max_ec_info_strip_size": 0,
- "name": "string",
- "nfs_whitelist": [
- "string"
], - "nfs_whitelist_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "annotation": 0,
- "annotation_data": {
- "annotations": {
- "property1": null,
- "property2": null
}, - "declared_annotations": {
- "property1": null,
- "property2": null
}, - "redefined_count": 0
}, - "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "class_redefined_count": 0,
- "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "enum": 0,
- "enum_constant_directory": {
- "property1": null,
- "property2": null
}, - "enum_constants": null,
- "generic_info": {
- "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "super_interfaces": [
- null
], - "superclass": { }
}, - "initted": true,
- "name": "string",
- "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "reflection_data": {
- "clock": 0,
- "timestamp": 0
}, - "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "serial_persistent_fields": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "synthetic": 0,
- "use_caches": true
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "nfs_whitelist_inherited": true,
- "on_disk_dedup": "NONE",
- "oplog_replication_factor": 0,
- "prefer_higher_ecfault_domain": true,
- "random_io_preference": [
- "string"
], - "replication_factor": 0,
- "seq_io_preference": [
- "string"
], - "software_inline_ec_type": "ContainerDTO.SoftwareInlineEcType(type same-vdisk-strips)",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "storage_container_uuid": "string",
- "storage_pool_id": "string",
- "storage_pool_uuid": "string",
- "total_explicit_reserved_capacity": 0,
- "total_implicit_reserved_capacity": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vstore_name_list": [
- "string"
]
}
uuid required | string Uuid of a Storage Container |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers/{uuid}/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of alerts |
resolved | boolean Alerts which have been resolved |
acknowledged | boolean Alerts which have been acknowledged |
severity | string Alert severities |
alert_type_uuid | string Alert type ids |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers/alerts \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
uuid required | string Uuid of a Storage Container |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers/{uuid}/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
count | integer <int32> Maximum number of events |
acknowledged | boolean Events which have been acknowledged |
page | integer <int32> Page number |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers/events \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- {
- "metric_threshold_value": "string",
- "metric_value": "string",
- "state_change_time_stamp_in_usecs": 0
}
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- {
- "actions": "string",
- "alerts": "string",
- "cadmus": "string",
- "entities": "string",
- "help": "string",
- "metadata": {
- "entity_type": "PAGE",
- "filters": [
- null
], - "instances": [
- null
], - "title": "string"
}, - "perspectives": [
- {
- "format": null,
- "metadata": null,
- "query": null,
- "result": null,
- "type": null
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of NFS Datastores mounted using Storage Containers in the cluster.
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers/datastores \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
[- {
- "capacity": 0,
- "container_id": "string",
- "container_name": "string",
- "container_uuid": "string",
- "datastore_name": "string",
- "free_space": 0,
- "host_id": "string",
- "host_ip_address": "string",
- "host_uuid": "string",
- "storage_container_id": "string",
- "storage_container_name": "string",
- "storage_container_uuid": "string",
- "vm_names": [
- "string"
]
}
]
Get the list of Storage Containers configured in the cluster.
count | integer <int32> Number of Storage Containers to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
search_string | string Search string |
search_attribute_list | Array of strings Search attribute list |
page | integer <int32> Page number |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "advertised_capacity": 0,
- "affinity_host_uuid": "string",
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "cluster_uuid": "string",
- "compression_delay_in_secs": 0,
- "compression_enabled": true,
- "container_uuid": "string",
- "down_migrate_times_in_secs": {
- "property1": 0,
- "property2": 0
}, - "enable_software_encryption": true,
- "encrypted": true,
- "erasure_code": "string",
- "erasure_code_delay_secs": 0,
- "finger_print_on_write": "NONE",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "id": "string",
- "ilm_policy": "string",
- "inline_ec_enabled": true,
- "is_nutanix_managed": true,
- "mapped_remote_containers": {
- "property1": "string",
- "property2": "string"
}, - "marked_for_removal": true,
- "max_capacity": 0,
- "max_ec_info_strip_size": 0,
- "name": "string",
- "nfs_whitelist": [
- "string"
], - "nfs_whitelist_address": [
- {
- "hostname": "string",
- "inet_address": {
- "empty": {
- "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "value": null
}, - "value": {
- "$assertions_disabled": true,
- "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "address_cache_init": true,
- "cache_lock": { },
- "cache_time": 0,
- "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "canonical_host_name": "string",
- "fields_offset": 0,
- "holder": {
- "address": 0,
- "family": 0,
- "host_name": "string",
- "original_host_name": "string"
}, - "impl": { },
- "ipv4": 0,
- "ipv6": 0,
- "lookup_table": {
- "property1": null,
- "property2": null
}, - "max_cache_time": 0,
- "name_services": [
- { }
], - "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "prefer_ipv6_address": true,
- "serial_persistent_fields": [
- {
- "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.",
- "name": "string",
- "offset": 0,
- "signature": "string",
- "type": {
- "all_perm_domain": null,
- "annotation": null,
- "annotation_data": null,
- "annotation_type": null,
- "cached_constructor": null,
- "class_redefined_count": null,
- "class_value_map": null,
- "enum": null,
- "enum_constant_directory": { },
- "enum_constants": null,
- "generic_info": null,
- "initted": null,
- "name": null,
- "new_instance_caller_cache": null,
- "reflection_data": null,
- "reflection_factory": null,
- "serial_persistent_fields": [ ],
- "synthetic": null,
- "use_caches": null
}, - "unshared": true
}
], - "unknown_array": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "unsafe": {
- "address_size": 0,
- "array_boolean_base_offset": 0,
- "array_boolean_index_scale": 0,
- "array_byte_base_offset": 0,
- "array_byte_index_scale": 0,
- "array_char_base_offset": 0,
- "array_char_index_scale": 0,
- "array_double_base_offset": 0,
- "array_double_index_scale": 0,
- "array_float_base_offset": 0,
- "array_float_index_scale": 0,
- "array_int_base_offset": 0,
- "array_int_index_scale": 0,
- "array_long_base_offset": 0,
- "array_long_index_scale": 0,
- "array_object_base_offset": 0,
- "array_object_index_scale": 0,
- "array_short_base_offset": 0,
- "array_short_index_scale": 0,
- "invalid_field_offset": 0,
- "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
}
}
}, - "ipv4": "string",
- "ipv6": "string",
- "log": {
- "root_logger_name": "string"
}, - "port": 0,
- "raw_string": "string",
- "subnet": "string",
- "subnet_sep": "string"
}
], - "nfs_whitelist_inherited": true,
- "on_disk_dedup": "NONE",
- "oplog_replication_factor": 0,
- "prefer_higher_ecfault_domain": true,
- "random_io_preference": [
- "string"
], - "replication_factor": 0,
- "seq_io_preference": [
- "string"
], - "software_inline_ec_type": "ContainerDTO.SoftwareInlineEcType(type same-vdisk-strips)",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "storage_container_uuid": "string",
- "storage_pool_id": "string",
- "storage_pool_uuid": "string",
- "total_explicit_reserved_capacity": 0,
- "total_implicit_reserved_capacity": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vstore_name_list": [
- "string"
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of VDisks of the specified Container.
uuid required | string Uuid of a Storage Container |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers/{uuid}/vdisks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "cluster_uuid": "string",
- "container_id": "string",
- "container_name": "string",
- "container_uuid": "string",
- "creation_time_in_micros_since_epoch": 0,
- "disabled": true,
- "erasure_code": "string",
- "erasure_code_delay_secs": 0,
- "finger_print_on_write": "NONE",
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "immutable": true,
- "iscsi_lun": 0,
- "iscsi_target_name": "string",
- "marked_for_removal": true,
- "max_capacity_bytes": 0,
- "name": "string",
- "nfs_file": true,
- "nfs_file_name": "string",
- "on_disk_dedup": "NONE",
- "parent_nfs_file_name": "string",
- "qos_fairshare": "string",
- "qos_priority": "string",
- "shared": true,
- "snapshot": true,
- "snapshots": [
- "string"
], - "stats": {
- "property1": "string",
- "property2": "string"
}, - "storage_container_id": "string",
- "storage_container_name": "string",
- "storage_container_uuid": "string",
- "storage_pool_id": "string",
- "storage_pool_name": "string",
- "storage_pool_uuid": "string",
- "total_reserved_capacity_bytes": 0,
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "vdisk_uuid": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
If start time and end time are included in the query string, then historical stats are retrieved. Otherwise, the latest stats are retrieved.
uuid required | string Uuid of a Storage Container |
metrics required | Array of strings List of metrics |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
interval_in_secs | integer <int32> Sampling interval of stats |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers/{uuid}/stats \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "stats_specific_responses": [
- {
- "interval_in_secs": 0,
- "message": "string",
- "metric": "string",
- "start_time_in_usecs": 0,
- "successful": true,
- "values": [
- 0
]
}
]
}
Modify the specified Storage Container.
A Storage Container instance
cluster_uuid | string |
object (patch.dto.appliance.configuration.ContainerDTO) | |
operation | string |
curl --request PATCH \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid": "string", "generic_dto": { "advertised_capacity": 0, "affinity_host_uuid": "string", "alert_summary": { "alert_summaries": { "property1": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "property2": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } } }, "count": 0 }, "cluster_uuid": "string", "compression_delay_in_secs": 0, "compression_enabled": true, "container_uuid": "string", "down_migrate_times_in_secs": { "property1": 0, "property2": 0 }, "enable_software_encryption": true, "encrypted": true, "erasure_code": "string", "erasure_code_delay_secs": 0, "finger_print_on_write": "NONE", "health_summary": { "entity_type_summaries": [ { "checks_in_error": { "property1": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] }, "property2": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] } }, "detailed_check_summary": { "property1": {}, "property2": {} }, "entity_type": "PAGE", "filter_criteria": "string", "health_summary": { "property1": 0, "property2": 0 } } ], "health_check_summaries": { "property1": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 }, "property2": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 } }, "health_status": "Critical" }, "id": "string", "ilm_policy": "string", "inline_ec_enabled": true, "is_nutanix_managed": true, "mapped_remote_containers": { "property1": "string", "property2": "string" }, "marked_for_removal": true, "max_capacity": 0, "max_ec_info_strip_size": 0, "name": "string", "nfs_whitelist": [ "string" ], "nfs_whitelist_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "nfs_whitelist_inherited": true, "on_disk_dedup": "NONE", "oplog_replication_factor": 0, "prefer_higher_ecfault_domain": true, "random_io_preference": [ "string" ], "replication_factor": 0, "seq_io_preference": [ "string" ], "software_inline_ec_type": "ContainerDTO.SoftwareInlineEcType(type same-vdisk-strips)", "stats": { "property1": "string", "property2": "string" }, "storage_container_uuid": "string", "storage_pool_id": "string", "storage_pool_uuid": "string", "total_explicit_reserved_capacity": 0, "total_implicit_reserved_capacity": 0, "usage_stats": { "property1": "string", "property2": "string" }, "vstore_name_list": [ "string" ] }, "operation": "string" }'
{- "value": true
}
Remove an NFS Datastore.
Remove request
datastore_name | string |
node_ids | Array of strings |
node_uuids | Array of strings |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers/datastores/remove_datastore \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "datastore_name": "string", "node_ids": [ "string" ], "node_uuids": [ "string" ] }'
{- "node_specific_status": [
- {
- "message": "string",
- "node_id": "string",
- "node_uuid": "string",
- "successful": true
}
]
}
Update the specified Storage Container.
A Storage Container instance
advertised_capacity | integer <int64> |
affinity_host_uuid | string |
object (update.dto.alerts.AlertSummaryDTO) | |
cluster_uuid | string |
compression_delay_in_secs | integer <int32> |
compression_enabled | boolean |
container_uuid | string |
object | |
enable_software_encryption | boolean |
encrypted | boolean |
erasure_code | string |
erasure_code_delay_secs | integer <int32> |
finger_print_on_write | string Enum: "NONE" "OFF" "ON" |
object (update.dto.health.check.HealthSummaryDTO) | |
id | string |
ilm_policy | string |
inline_ec_enabled | boolean |
is_nutanix_managed | boolean |
object | |
marked_for_removal | boolean |
max_capacity | integer <int64> |
max_ec_info_strip_size | integer <int32> |
name | string |
nfs_whitelist | Array of strings |
Array of objects (update.common.Address) | |
nfs_whitelist_inherited | boolean |
on_disk_dedup | string Enum: "NONE" "OFF" "POST_PROCESS" |
oplog_replication_factor | integer <int32> |
prefer_higher_ecfault_domain | boolean |
random_io_preference | Array of strings |
replication_factor | integer <int32> |
seq_io_preference | Array of strings |
software_inline_ec_type | string Enum: "ContainerDTO.SoftwareInlineEcType(type same-vdisk-strips)" "ContainerDTO.SoftwareInlineEcType(type cross-vdisk-strips)" |
object | |
storage_container_uuid | string |
storage_pool_id | string |
storage_pool_uuid | string |
total_explicit_reserved_capacity | integer <int64> |
total_implicit_reserved_capacity | integer <int64> |
object | |
vstore_name_list | Array of strings |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/storage_containers \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "advertised_capacity": 0, "affinity_host_uuid": "string", "alert_summary": { "alert_summaries": { "property1": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "property2": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } } }, "count": 0 }, "cluster_uuid": "string", "compression_delay_in_secs": 0, "compression_enabled": true, "container_uuid": "string", "down_migrate_times_in_secs": { "property1": 0, "property2": 0 }, "enable_software_encryption": true, "encrypted": true, "erasure_code": "string", "erasure_code_delay_secs": 0, "finger_print_on_write": "NONE", "health_summary": { "entity_type_summaries": [ { "checks_in_error": { "property1": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] }, "property2": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] } }, "detailed_check_summary": { "property1": {}, "property2": {} }, "entity_type": "PAGE", "filter_criteria": "string", "health_summary": { "property1": 0, "property2": 0 } } ], "health_check_summaries": { "property1": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 }, "property2": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 } }, "health_status": "Critical" }, "id": "string", "ilm_policy": "string", "inline_ec_enabled": true, "is_nutanix_managed": true, "mapped_remote_containers": { "property1": "string", "property2": "string" }, "marked_for_removal": true, "max_capacity": 0, "max_ec_info_strip_size": 0, "name": "string", "nfs_whitelist": [ "string" ], "nfs_whitelist_address": [ { "hostname": "string", "inet_address": { "empty": { "empty": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "value": null }, "value": { "$assertions_disabled": true, "address_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "address_cache_init": true, "cache_lock": {}, "cache_time": 0, "cached_local_host": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "canonical_host_name": "string", "fields_offset": 0, "holder": { "address": 0, "family": 0, "host_name": "string", "original_host_name": "string" }, "impl": {}, "ipv4": 0, "ipv6": 0, "lookup_table": { "property1": {}, "property2": {} }, "max_cache_time": 0, "name_services": [ {} ], "negative_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "prefer_ipv6_address": true, "serial_persistent_fields": [ { "field": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "name": "string", "offset": 0, "signature": "string", "type": { "all_perm_domain": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "annotation": 0, "annotation_data": { "annotations": { "property1": {}, "property2": {} }, "declared_annotations": { "property1": {}, "property2": {} }, "redefined_count": 0 }, "annotation_type": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "cached_constructor": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "class_redefined_count": 0, "class_value_map": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "enum": 0, "enum_constant_directory": { "property1": {}, "property2": {} }, "enum_constants": null, "generic_info": { "none": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "super_interfaces": [ {} ], "superclass": {} }, "initted": true, "name": "string", "new_instance_caller_cache": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "reflection_data": { "clock": 0, "timestamp": 0 }, "reflection_factory": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information.", "serial_persistent_fields": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "synthetic": 0, "use_caches": true }, "unshared": true } ], "unknown_array": [ "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." ], "unsafe": { "address_size": 0, "array_boolean_base_offset": 0, "array_boolean_index_scale": 0, "array_byte_base_offset": 0, "array_byte_index_scale": 0, "array_char_base_offset": 0, "array_char_index_scale": 0, "array_double_base_offset": 0, "array_double_index_scale": 0, "array_float_base_offset": 0, "array_float_index_scale": 0, "array_int_base_offset": 0, "array_int_index_scale": 0, "array_long_base_offset": 0, "array_long_index_scale": 0, "array_object_base_offset": 0, "array_object_index_scale": 0, "array_short_base_offset": 0, "array_short_index_scale": 0, "invalid_field_offset": 0, "the_unsafe": "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information." } } }, "ipv4": "string", "ipv6": "string", "log": { "root_logger_name": "string" }, "port": 0, "raw_string": "string", "subnet": "string", "subnet_sep": "string" } ], "nfs_whitelist_inherited": true, "on_disk_dedup": "NONE", "oplog_replication_factor": 0, "prefer_higher_ecfault_domain": true, "random_io_preference": [ "string" ], "replication_factor": 0, "seq_io_preference": [ "string" ], "software_inline_ec_type": "ContainerDTO.SoftwareInlineEcType(type same-vdisk-strips)", "stats": { "property1": "string", "property2": "string" }, "storage_container_uuid": "string", "storage_pool_id": "string", "storage_pool_uuid": "string", "total_explicit_reserved_capacity": 0, "total_implicit_reserved_capacity": 0, "usage_stats": { "property1": "string", "property2": "string" }, "vstore_name_list": [ "string" ] }'
{- "value": true
}
Cancel a running task.
include_subtasks_info | boolean whether to include detailed information of the immediate subtasks, defaults to false |
list of UUids
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/tasks/cancel \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- "string"
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get a list of generated tasks.
Request for fetching tasks
cluster_uuid_list | Array of strings |
count | integer <int32> |
cut_off_time_usecs | integer <int64> |
Array of objects (create.dto.ergon.EntityIdRequestDTO) | |
include_completed | boolean |
include_subtasks_info | boolean |
operation_type_list | Array of strings |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/tasks/list \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "cluster_uuid_list": [ "string" ], "count": 0, "cut_off_time_usecs": 0, "entity_list": [ { "entity_id": "string", "entity_type": "NODE" } ], "include_completed": true, "include_subtasks_info": true, "operation_type_list": [ "string" ] }'
{- "entities": [
- {
- "cluster_uuid": "string",
- "complete_time_usecs": 0,
- "create_time_usecs": 0,
- "display_name": "string",
- "entity_list": [
- {
- "entity_id": "string",
- "entity_name": "string",
- "entity_type": "NODE"
}
], - "last_updated_time_usecs": 0,
- "message": "string",
- "meta_request": {
- "method_name": "string"
}, - "meta_response": {
- "error_code": 0,
- "error_detail": "string"
}, - "operation_type": "string",
- "parent_task_uuid": "string",
- "percentage_complete": 0,
- "progress_status": "QUEUED",
- "start_time_usecs": 0,
- "subtask_info_list": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "subtask_uuid_list": [
- "string"
], - "uuid": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get details of the specified task.
uuid required | string UUID of the task |
include_subtasks_info | boolean Whether to include a detailed information of the immediate subtasks. Default value is false. |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/tasks/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "cluster_uuid": "string",
- "complete_time_usecs": 0,
- "create_time_usecs": 0,
- "display_name": "string",
- "entity_list": [
- {
- "entity_id": "string",
- "entity_name": "string",
- "entity_type": "NODE"
}
], - "last_updated_time_usecs": 0,
- "message": "string",
- "meta_request": {
- "method_name": "string"
}, - "meta_response": {
- "error_code": 0,
- "error_detail": "string"
}, - "operation_type": "string",
- "parent_task_uuid": "string",
- "percentage_complete": 0,
- "progress_status": "QUEUED",
- "start_time_usecs": 0,
- "subtask_info_list": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "subtask_uuid_list": [
- "string"
], - "uuid": "string"
}
Poll a task to check if its ready.
Task poll request
completed_tasks | Array of strings |
timeout_interval | integer <int64> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/tasks/poll \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "completed_tasks": [ "string" ], "timeout_interval": 0 }'
{- "completed_tasks_info": [
- {
- "cluster_uuid": "string",
- "complete_time_usecs": 0,
- "create_time_usecs": 0,
- "display_name": "string",
- "entity_list": [
- {
- "entity_id": "string",
- "entity_name": "string",
- "entity_type": "NODE"
}
], - "last_updated_time_usecs": 0,
- "message": "string",
- "meta_request": {
- "method_name": "string"
}, - "meta_response": {
- "error_code": 0,
- "error_detail": "string"
}, - "operation_type": "string",
- "parent_task_uuid": "string",
- "percentage_complete": 0,
- "progress_status": "QUEUED",
- "start_time_usecs": 0,
- "subtask_info_list": [
- "This API contains a circular reference, Refer to the spec file that can be downloaded from the documentation for more information."
], - "subtask_uuid_list": [
- "string"
], - "uuid": "string"
}
], - "timed_out": true
}
type required | string |
name required | string |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/{type}/softwares/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
type required | string |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/{type}/configuration \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "enable_automatic_downloads": true
}
type required | string |
name required | string |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/{type}/softwares/{name} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "cmsp_required": true,
- "compatible_fs_versions": [
- "string"
], - "compatible_fsm_versions": [
- "string"
], - "compatible_nos_versions": [
- "string"
], - "compatible_pe_nos_versions": [
- "string"
], - "compatible_platforms": [
- "string"
], - "compatible_versions": [
- "string"
], - "current_size_in_bytes": 0,
- "full_release_version": "string",
- "gpg_signature": "string",
- "hypervisor_installer_string": "string",
- "hypervisor_type": "string",
- "is_lts": true,
- "log": {
- "root_logger_name": "string"
}, - "md5_sum": "string",
- "min_nos_version": "string",
- "min_pcversion": "string",
- "minimum_requirements_dto": {
- "memory_gb": 0,
- "storage_gb": 0,
- "v_cpus": 0
}, - "name": "string",
- "prism_central_sizes": [
- {
- "disk_size_in_gib": 0,
- "memory_size_in_gib": 0,
- "num_vms_supported": 0,
- "pc_vm_form_factor": "string",
- "vcpus": 0
}
], - "qualified_date": 0,
- "release_date": 0,
- "release_note_url": "string",
- "software_type": "NOS",
- "status": "NONE",
- "supported_models": [
- "string"
], - "total_size_in_bytes": 0,
- "transfer_type": "AUTOMATIC_DOWNLOAD",
- "upgrade_notification": {
- "cancel_message": "string",
- "description_item_list": [
- {
- "affected_releases": [
- "string"
], - "message": "string",
- "severity_level": "string"
}
], - "proceed_message": "string",
- "title": "string"
}, - "url": "string",
- "version": "string"
}
type required | string |
release_type | string |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/{type}/softwares \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "cmsp_required": true,
- "compatible_fs_versions": [
- "string"
], - "compatible_fsm_versions": [
- "string"
], - "compatible_nos_versions": [
- "string"
], - "compatible_pe_nos_versions": [
- "string"
], - "compatible_platforms": [
- "string"
], - "compatible_versions": [
- "string"
], - "current_size_in_bytes": 0,
- "full_release_version": "string",
- "gpg_signature": "string",
- "hypervisor_installer_string": "string",
- "hypervisor_type": "string",
- "is_lts": true,
- "log": {
- "root_logger_name": "string"
}, - "md5_sum": "string",
- "min_nos_version": "string",
- "min_pcversion": "string",
- "minimum_requirements_dto": {
- "memory_gb": 0,
- "storage_gb": 0,
- "v_cpus": 0
}, - "name": "string",
- "prism_central_sizes": [
- {
- "disk_size_in_gib": 0,
- "memory_size_in_gib": 0,
- "num_vms_supported": 0,
- "pc_vm_form_factor": "string",
- "vcpus": 0
}
], - "qualified_date": 0,
- "release_date": 0,
- "release_note_url": "string",
- "software_type": "NOS",
- "status": "NONE",
- "supported_models": [
- "string"
], - "total_size_in_bytes": 0,
- "transfer_type": "AUTOMATIC_DOWNLOAD",
- "upgrade_notification": {
- "cancel_message": "string",
- "description_item_list": [
- {
- "affected_releases": [
- "string"
], - "message": "string",
- "severity_level": "string"
}
], - "proceed_message": "string",
- "title": "string"
}, - "url": "string",
- "version": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
type required | string |
version required | string |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/validate_compatibility/{type}/{version} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "value": true
}
type required | string |
max_skip_buffer_size | integer <int32> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/{type}/metadata \ --header 'Accept: application/json' \ --header 'Content-Type: application/octet-stream' \ --data '{ "max_skip_buffer_size": 0 }'
{- "value": true
}
type required | string |
name required | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/{type}/softwares/{name}/cancel_transfer \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "cmsp_required": true,
- "compatible_fs_versions": [
- "string"
], - "compatible_fsm_versions": [
- "string"
], - "compatible_nos_versions": [
- "string"
], - "compatible_pe_nos_versions": [
- "string"
], - "compatible_platforms": [
- "string"
], - "compatible_versions": [
- "string"
], - "current_size_in_bytes": 0,
- "full_release_version": "string",
- "gpg_signature": "string",
- "hypervisor_installer_string": "string",
- "hypervisor_type": "string",
- "is_lts": true,
- "log": {
- "root_logger_name": "string"
}, - "md5_sum": "string",
- "min_nos_version": "string",
- "min_pcversion": "string",
- "minimum_requirements_dto": {
- "memory_gb": 0,
- "storage_gb": 0,
- "v_cpus": 0
}, - "name": "string",
- "prism_central_sizes": [
- {
- "disk_size_in_gib": 0,
- "memory_size_in_gib": 0,
- "num_vms_supported": 0,
- "pc_vm_form_factor": "string",
- "vcpus": 0
}
], - "qualified_date": 0,
- "release_date": 0,
- "release_note_url": "string",
- "software_type": "NOS",
- "status": "NONE",
- "supported_models": [
- "string"
], - "total_size_in_bytes": 0,
- "transfer_type": "AUTOMATIC_DOWNLOAD",
- "upgrade_notification": {
- "cancel_message": "string",
- "description_item_list": [
- {
- "affected_releases": [
- "string"
], - "message": "string",
- "severity_level": "string"
}
], - "proceed_message": "string",
- "title": "string"
}, - "url": "string",
- "version": "string"
}
type required | string |
name required | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/{type}/softwares/{name}/download \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "cmsp_required": true,
- "compatible_fs_versions": [
- "string"
], - "compatible_fsm_versions": [
- "string"
], - "compatible_nos_versions": [
- "string"
], - "compatible_pe_nos_versions": [
- "string"
], - "compatible_platforms": [
- "string"
], - "compatible_versions": [
- "string"
], - "current_size_in_bytes": 0,
- "full_release_version": "string",
- "gpg_signature": "string",
- "hypervisor_installer_string": "string",
- "hypervisor_type": "string",
- "is_lts": true,
- "log": {
- "root_logger_name": "string"
}, - "md5_sum": "string",
- "min_nos_version": "string",
- "min_pcversion": "string",
- "minimum_requirements_dto": {
- "memory_gb": 0,
- "storage_gb": 0,
- "v_cpus": 0
}, - "name": "string",
- "prism_central_sizes": [
- {
- "disk_size_in_gib": 0,
- "memory_size_in_gib": 0,
- "num_vms_supported": 0,
- "pc_vm_form_factor": "string",
- "vcpus": 0
}
], - "qualified_date": 0,
- "release_date": 0,
- "release_note_url": "string",
- "software_type": "NOS",
- "status": "NONE",
- "supported_models": [
- "string"
], - "total_size_in_bytes": 0,
- "transfer_type": "AUTOMATIC_DOWNLOAD",
- "upgrade_notification": {
- "cancel_message": "string",
- "description_item_list": [
- {
- "affected_releases": [
- "string"
], - "message": "string",
- "severity_level": "string"
}
], - "proceed_message": "string",
- "title": "string"
}, - "url": "string",
- "version": "string"
}
type required | string |
name required | string |
overwrite | boolean |
file_size | integer <int64> |
md5sum | string |
version | string |
offset | integer <int64> |
hypervisor_type | string |
software_metadata | string |
max_skip_buffer_size | integer <int32> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/{type}/softwares/{name}/upload \ --header 'Accept: application/json' \ --header 'Content-Type: application/octet-stream' \ --header 'software_metadata: string' \ --data '{ "max_skip_buffer_size": 0 }'
{- "cmsp_required": true,
- "compatible_fs_versions": [
- "string"
], - "compatible_fsm_versions": [
- "string"
], - "compatible_nos_versions": [
- "string"
], - "compatible_pe_nos_versions": [
- "string"
], - "compatible_platforms": [
- "string"
], - "compatible_versions": [
- "string"
], - "current_size_in_bytes": 0,
- "full_release_version": "string",
- "gpg_signature": "string",
- "hypervisor_installer_string": "string",
- "hypervisor_type": "string",
- "is_lts": true,
- "log": {
- "root_logger_name": "string"
}, - "md5_sum": "string",
- "min_nos_version": "string",
- "min_pcversion": "string",
- "minimum_requirements_dto": {
- "memory_gb": 0,
- "storage_gb": 0,
- "v_cpus": 0
}, - "name": "string",
- "prism_central_sizes": [
- {
- "disk_size_in_gib": 0,
- "memory_size_in_gib": 0,
- "num_vms_supported": 0,
- "pc_vm_form_factor": "string",
- "vcpus": 0
}
], - "qualified_date": 0,
- "release_date": 0,
- "release_note_url": "string",
- "software_type": "NOS",
- "status": "NONE",
- "supported_models": [
- "string"
], - "total_size_in_bytes": 0,
- "transfer_type": "AUTOMATIC_DOWNLOAD",
- "upgrade_notification": {
- "cancel_message": "string",
- "description_item_list": [
- {
- "affected_releases": [
- "string"
], - "message": "string",
- "severity_level": "string"
}
], - "proceed_message": "string",
- "title": "string"
}, - "url": "string",
- "version": "string"
}
type required | string |
metadata | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/{type}/softwares/download \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "cmsp_required": true,
- "compatible_fs_versions": [
- "string"
], - "compatible_fsm_versions": [
- "string"
], - "compatible_nos_versions": [
- "string"
], - "compatible_pe_nos_versions": [
- "string"
], - "compatible_platforms": [
- "string"
], - "compatible_versions": [
- "string"
], - "current_size_in_bytes": 0,
- "full_release_version": "string",
- "gpg_signature": "string",
- "hypervisor_installer_string": "string",
- "hypervisor_type": "string",
- "is_lts": true,
- "log": {
- "root_logger_name": "string"
}, - "md5_sum": "string",
- "min_nos_version": "string",
- "min_pcversion": "string",
- "minimum_requirements_dto": {
- "memory_gb": 0,
- "storage_gb": 0,
- "v_cpus": 0
}, - "name": "string",
- "prism_central_sizes": [
- {
- "disk_size_in_gib": 0,
- "memory_size_in_gib": 0,
- "num_vms_supported": 0,
- "pc_vm_form_factor": "string",
- "vcpus": 0
}
], - "qualified_date": 0,
- "release_date": 0,
- "release_note_url": "string",
- "software_type": "NOS",
- "status": "NONE",
- "supported_models": [
- "string"
], - "total_size_in_bytes": 0,
- "transfer_type": "AUTOMATIC_DOWNLOAD",
- "upgrade_notification": {
- "cancel_message": "string",
- "description_item_list": [
- {
- "affected_releases": [
- "string"
], - "message": "string",
- "severity_level": "string"
}
], - "proceed_message": "string",
- "title": "string"
}, - "url": "string",
- "version": "string"
}
type required | string |
max_skip_buffer_size | integer <int32> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/{type}/softwares/validate_upload \ --header 'Accept: application/json' \ --header 'Content-Type: application/octet-stream' \ --data '{ "max_skip_buffer_size": 0 }'
{- "value": "string"
}
property name* additional property | object (java.lang.Object) |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/hypervisor_installer/softwares \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "cmsp_required": true,
- "compatible_fs_versions": [
- "string"
], - "compatible_fsm_versions": [
- "string"
], - "compatible_nos_versions": [
- "string"
], - "compatible_pe_nos_versions": [
- "string"
], - "compatible_platforms": [
- "string"
], - "compatible_versions": [
- "string"
], - "current_size_in_bytes": 0,
- "full_release_version": "string",
- "gpg_signature": "string",
- "hypervisor_installer_string": "string",
- "hypervisor_type": "string",
- "is_lts": true,
- "log": {
- "root_logger_name": "string"
}, - "md5_sum": "string",
- "min_nos_version": "string",
- "min_pcversion": "string",
- "minimum_requirements_dto": {
- "memory_gb": 0,
- "storage_gb": 0,
- "v_cpus": 0
}, - "name": "string",
- "prism_central_sizes": [
- {
- "disk_size_in_gib": 0,
- "memory_size_in_gib": 0,
- "num_vms_supported": 0,
- "pc_vm_form_factor": "string",
- "vcpus": 0
}
], - "qualified_date": 0,
- "release_date": 0,
- "release_note_url": "string",
- "software_type": "NOS",
- "status": "NONE",
- "supported_models": [
- "string"
], - "total_size_in_bytes": 0,
- "transfer_type": "AUTOMATIC_DOWNLOAD",
- "upgrade_notification": {
- "cancel_message": "string",
- "description_item_list": [
- {
- "affected_releases": [
- "string"
], - "message": "string",
- "severity_level": "string"
}
], - "proceed_message": "string",
- "title": "string"
}, - "url": "string",
- "version": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
type required | string |
enable_automatic_downloads | boolean |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/upgrade/{type}/configuration \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "enable_automatic_downloads": true }'
{- "enable_automatic_downloads": true
}
Get a list of vdisks in the cluster.
path required | string Path of ndfs file |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vdisks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "file_path": "string",
- "file_type": "FILE",
- "name": "string",
- "total_size": 0,
- "used_size": 0
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get the list of VirtualDisks configured in the cluster.
count | integer <int32> Number of VirtualDisks to retrieve |
filter_criteria | string Filter criteria |
sort_criteria | string Sort criteria |
search_string | string Search string |
search_attribute_list | Array of strings Search attribute list |
page | integer <int32> Page number |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/virtual_disks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": null,
- "entity_type": null,
- "entity_type_display_name": null,
- "id": null,
- "uuid": null
}
], - "alert_details": {
- "metric_details": [
- null
], - "severity_trails": [
- null
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": null,
- "additional_links": null,
- "alert_namespace": null,
- "cause": null,
- "chart_queries": null,
- "details": null,
- "has_global_details": null,
- "id": null,
- "num_resolved_count": null,
- "parent_cause_id": null,
- "title": null,
- "troubleshooting_steps": null
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "attached_vm_id": "string",
- "attached_vm_uuid": "string",
- "attached_vmname": "string",
- "attached_volume_group_id": "string",
- "cluster_uuid": "string",
- "container_id": "string",
- "container_uuid": "string",
- "datasource_uuid": "string",
- "device_uuid": "string",
- "disk_address": "string",
- "disk_capacity_in_bytes": 0,
- "flash_mode_enabled": true,
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
], - "node_level": [
- {
- "entity_name": null,
- "entity_uuid": null,
- "message": null
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "nutanix_nfsfile_path": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "storage_container_id": "string",
- "storage_container_uuid": "string",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "virtual_disk_id": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
If start time and end time are included in the query string, then historical stats are retrieved. Otherwise, the latest stats are retrieved.
uuid required | string Uuid of the VirtualDisk |
metrics required | Array of strings List of metrics |
start_time_in_usecs | integer <int64> Start time in microseconds |
end_time_in_usecs | integer <int64> End time in microseconds |
interval_in_secs | integer <int32> Sampling interval of stats |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/virtual_disks/{uuid}/stats \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "stats_specific_responses": [
- {
- "interval_in_secs": 0,
- "message": "string",
- "metric": "string",
- "start_time_in_usecs": 0,
- "successful": true,
- "values": [
- 0
]
}
]
}
Get VirtualDisk with the specified Uuid.
uuid required | string Uuid of the VirtualDisk |
projection | string Projections on the attributes |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/virtual_disks/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "attached_vm_id": "string",
- "attached_vm_uuid": "string",
- "attached_vmname": "string",
- "attached_volume_group_id": "string",
- "cluster_uuid": "string",
- "container_id": "string",
- "container_uuid": "string",
- "datasource_uuid": "string",
- "device_uuid": "string",
- "disk_address": "string",
- "disk_capacity_in_bytes": 0,
- "flash_mode_enabled": true,
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "nutanix_nfsfile_path": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "storage_container_id": "string",
- "storage_container_uuid": "string",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "virtual_disk_id": "string"
}
DTO specifying different parameters for VirtualDisk along with flash mode
object (update.dto.alerts.AlertSummaryDTO) | |
attached_vm_id | string |
attached_vm_uuid | string |
attached_vmname | string |
attached_volume_group_id | string |
cluster_uuid | string |
container_id | string |
container_uuid | string |
datasource_uuid | string |
device_uuid | string |
disk_address | string |
disk_capacity_in_bytes | integer <int64> |
flash_mode_enabled | boolean |
object (update.dto.health.check.HealthSummaryDTO) | |
nutanix_nfsfile_path | string |
object | |
storage_container_id | string |
storage_container_uuid | string |
object | |
uuid | string |
virtual_disk_id | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/virtual_disks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "alert_summary": { "alert_summaries": { "property1": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "property2": { "entities": [ { "acknowledged": true, "acknowledged_by_username": "string", "acknowledged_time_stamp_in_usecs": 0, "affected_entities": [ { "entity_name": "string", "entity_type": "string", "entity_type_display_name": "string", "id": "string", "uuid": "string" } ], "alert_details": { "metric_details": [ { "comparison_operator": "string", "condition_type": "STATIC_THRESHOLD", "data_type": "LONG", "entity_id": "string", "entity_type": "string", "metric_category": "string", "metric_display_name": "string", "metric_name": "string", "metric_value_details": [ { "metric_threshold_value": "string", "metric_value": "string", "state_change_time_stamp_in_usecs": 0 } ], "unit": "string" } ], "severity_trails": [ { "severity": "string", "severity_change_timestamp_in_usecs": 0 } ] }, "alert_title": "string", "alert_type_uuid": "string", "auto_resolved": true, "categories": [ "string" ], "check_id": "string", "classifications": [ "string" ], "cluster_uuid": "string", "context_types": [ "string" ], "context_values": [ "string" ], "created_time_stamp_in_usecs": 0, "detailed_message": "string", "entity_ids": [ "string" ], "entity_types": [ "string" ], "entity_uuids": [ "string" ], "id": "string", "impact": "string", "impact_types": [ "string" ], "last_occurrence_time_stamp_in_usecs": 0, "message": "string", "node_uuid": "string", "operation_type": "string", "originating_cluster_uuid": "string", "possible_causes": [ { "actions": "string", "additional_links": "string", "alert_namespace": "string", "cause": "string", "chart_queries": { "entities": [ { "actions": "string", "alerts": "string", "cadmus": "string", "entities": "string", "help": "string", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "perspectives": [ { "format": "TABLE", "metadata": { "entity_type": "PAGE", "filters": [ { "display_for_rhs": "string", "lhs": "string", "operator": "string", "rhs": "string" } ], "instances": [ { "additional_fields": { "property1": "string", "property2": "string" }, "cluster_uuid": "string", "context_hint_field": "string", "context_hint_value": "string", "entity_id": "string", "entity_name": "string", "entity_type": "PAGE" } ], "title": "string" }, "query": null, "result": null, "type": "string" } ] } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } }, "details": "string", "has_global_details": true, "id": "string", "num_resolved_count": 0, "parent_cause_id": "string", "title": "string", "troubleshooting_steps": "string" } ], "resolved": true, "resolved_by_username": "string", "resolved_time_stamp_in_usecs": 0, "service_vmid": "string", "severity": "string", "user_defined": true } ], "error_info": { "count": 0, "entity_list": [ "string" ], "message": "string" }, "metadata": { "count": 0, "end_index": 0, "filter_criteria": "string", "grand_total_entities": 0, "next_cursor": "string", "page": 0, "previous_cursor": "string", "search_string": "string", "sort_criteria": "string", "start_index": 0, "total_entities": 0 } } }, "count": 0 }, "attached_vm_id": "string", "attached_vm_uuid": "string", "attached_vmname": "string", "attached_volume_group_id": "string", "cluster_uuid": "string", "container_id": "string", "container_uuid": "string", "datasource_uuid": "string", "device_uuid": "string", "disk_address": "string", "disk_capacity_in_bytes": 0, "flash_mode_enabled": true, "health_summary": { "entity_type_summaries": [ { "checks_in_error": { "property1": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] }, "property2": { "cluster_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ], "node_level": [ { "entity_name": "string", "entity_uuid": "string", "message": "string" } ] } }, "detailed_check_summary": { "property1": {}, "property2": {} }, "entity_type": "PAGE", "filter_criteria": "string", "health_summary": { "property1": 0, "property2": 0 } } ], "health_check_summaries": { "property1": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 }, "property2": { "attribute_map": { "property1": "string", "property2": "string" }, "executed_time_stamp_in_usecs": 0, "health_status": "Critical", "id": "string", "score": 0 } }, "health_status": "Critical" }, "nutanix_nfsfile_path": "string", "stats": { "property1": "string", "property2": "string" }, "storage_container_id": "string", "storage_container_uuid": "string", "usage_stats": { "property1": "string", "property2": "string" }, "uuid": "string", "virtual_disk_id": "string" }'
{- "alert_summary": {
- "alert_summaries": {
- "property1": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}, - "property2": {
- "entities": [
- {
- "acknowledged": true,
- "acknowledged_by_username": "string",
- "acknowledged_time_stamp_in_usecs": 0,
- "affected_entities": [
- {
- "entity_name": "string",
- "entity_type": "string",
- "entity_type_display_name": "string",
- "id": "string",
- "uuid": "string"
}
], - "alert_details": {
- "metric_details": [
- {
- "comparison_operator": "string",
- "condition_type": "STATIC_THRESHOLD",
- "data_type": "LONG",
- "entity_id": "string",
- "entity_type": "string",
- "metric_category": "string",
- "metric_display_name": "string",
- "metric_name": "string",
- "metric_value_details": [
- null
], - "unit": "string"
}
], - "severity_trails": [
- {
- "severity": "string",
- "severity_change_timestamp_in_usecs": 0
}
]
}, - "alert_title": "string",
- "alert_type_uuid": "string",
- "auto_resolved": true,
- "categories": [
- "string"
], - "check_id": "string",
- "classifications": [
- "string"
], - "cluster_uuid": "string",
- "context_types": [
- "string"
], - "context_values": [
- "string"
], - "created_time_stamp_in_usecs": 0,
- "detailed_message": "string",
- "entity_ids": [
- "string"
], - "entity_types": [
- "string"
], - "entity_uuids": [
- "string"
], - "id": "string",
- "impact": "string",
- "impact_types": [
- "string"
], - "last_occurrence_time_stamp_in_usecs": 0,
- "message": "string",
- "node_uuid": "string",
- "operation_type": "string",
- "originating_cluster_uuid": "string",
- "possible_causes": [
- {
- "actions": "string",
- "additional_links": "string",
- "alert_namespace": "string",
- "cause": "string",
- "chart_queries": {
- "entities": [
- null
], - "error_info": {
- "count": null,
- "entity_list": [ ],
- "message": null
}, - "metadata": {
- "count": null,
- "end_index": null,
- "filter_criteria": null,
- "grand_total_entities": null,
- "next_cursor": null,
- "page": null,
- "previous_cursor": null,
- "search_string": null,
- "sort_criteria": null,
- "start_index": null,
- "total_entities": null
}
}, - "details": "string",
- "has_global_details": true,
- "id": "string",
- "num_resolved_count": 0,
- "parent_cause_id": "string",
- "title": "string",
- "troubleshooting_steps": "string"
}
], - "resolved": true,
- "resolved_by_username": "string",
- "resolved_time_stamp_in_usecs": 0,
- "service_vmid": "string",
- "severity": "string",
- "user_defined": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
}, - "count": 0
}, - "attached_vm_id": "string",
- "attached_vm_uuid": "string",
- "attached_vmname": "string",
- "attached_volume_group_id": "string",
- "cluster_uuid": "string",
- "container_id": "string",
- "container_uuid": "string",
- "datasource_uuid": "string",
- "device_uuid": "string",
- "disk_address": "string",
- "disk_capacity_in_bytes": 0,
- "flash_mode_enabled": true,
- "health_summary": {
- "entity_type_summaries": [
- {
- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
], - "health_check_summaries": {
- "property1": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}, - "property2": {
- "attribute_map": {
- "property1": "string",
- "property2": "string"
}, - "executed_time_stamp_in_usecs": 0,
- "health_status": "Critical",
- "id": "string",
- "score": 0
}
}, - "health_status": "Critical"
}, - "nutanix_nfsfile_path": "string",
- "stats": {
- "property1": "string",
- "property2": "string"
}, - "storage_container_id": "string",
- "storage_container_uuid": "string",
- "usage_stats": {
- "property1": "string",
- "property2": "string"
}, - "uuid": "string",
- "virtual_disk_id": "string"
}
Add a NIC to a Virtual Machine. A VM NIC must be associated with a virtual network. It is not possible to change this association. To connect a VM to a different virtual network, it is necessary to create a new NIC. If the virtual network is managed (see POST /networks/), the NIC must be assigned an IPv4 address at creation time. If the network has no DHCP pool, the user must specify the IPv4 address manually. If the VM is running, the NIC is hot-added to the VM. The logical timestamp can optionally be provided for consistency. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the Virtual Machine logical timestamp. The logical timestamp can be obtained from the Virtual Machine object. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
uuid required | string UUID of the Virtual Machine |
NIC Config Info
Array of objects (create.dto.acropolis.VMNicSpecDTO) | |
uuid | string |
vm_logical_timestamp | integer <int64> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid}/nics \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "spec_list": [ { "adapter_type": "E1000", "ip_address": "string", "ip_addresses": [ "string" ], "is_connected": true, "mac_address": "string", "model": "string", "network_uuid": "string", "nic_uuid": "string", "port_id": "string", "request_ip": true, "requested_ip_address": "string", "vlan_mode": "Access" } ], "uuid": "string", "vm_logical_timestamp": 0 }'
{- "task_uuid": "string"
}
Attach disks to Virtual Machine.A disk drive may either be a regular disk drive, or a CD-ROM drive. Only CD-ROM drives may be empty. By default, regular disk drives are configured on the SCSI bus, and CD-ROM drives are configured on the IDE bus. The user may override this behavior with the deviceBus attribute. By default, a disk drive is placed on the first available bus slot. The user may override this behavior with the deviceIndex attribute. Disks on the SCSI bus may optionally be configured for passthrough on platforms that support iSCSI. When in passthrough mode, SCSI commands are passed directly to NDFS via iSCSI. When SCSI passthrough is disabled, the hypervisor provides a SCSI emulation layer, and treats the underlying iSCSI target as a block device. By default, SCSI passthrough is enabled for SCSI devices on supported platforms. If the disk image is cloned from an existing vmdisk or NFS file, the user may specify a minimum size for the resulting clone. This can be used to expand a disk image at clone time. If the VM is running, the disk is hot-added to the VM. Note that certain buses, like IDE, are not hot-pluggable. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
uuid required | string Id of the Virtual Machine |
Info about the virtual disks or CD-Roms to be attached
uuid | string |
Array of objects (create.dto.uhura.VMDiskDTO) |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid}/disks/attach \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "uuid": "string", "vm_disks": [ { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "flash_mode_enabled": true, "is_cdrom": true, "is_empty": true, "is_scsi_pass_through": true, "is_thin_provisioned": true, "vm_disk_clone": { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "minimum_size": 0, "snapshot_group_uuid": "string", "storage_container_uuid": "string" }, "vm_disk_clone_external": { "external_disk_url": "string", "size": 0, "storage_container_uuid": "string" }, "vm_disk_create": { "size": 0, "storage_container_uuid": "string" }, "vm_disk_passthru_external": { "external_disk_url": "string", "storage_container_uuid": "string" } } ] }'
{- "task_uuid": "string"
}
Clone a Virtual Machine from a snapshot or Virtual Machine.If a UUID is specified for the cloned Virtual Machine, this operation will be idempotent. If override_network_config is set to true in the clone spec, then the source Virtual Machine s network configuration is overridden by one specified in the nic list. If false, the clone will inherit its basic network configuration from the source, minus MAC and IP address. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
uuid required | string Id of the Virtual Machine |
Clone a Virtual Machine
container_uuid | string |
source_vmlogical_timestamp | integer <int64> |
Array of objects (create.dto.acropolis.VMCloneSpecDTO) | |
storage_container_uuid | string |
uuid | string |
object (create.dto.acropolis.VMCustomizationConfigDTO) |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid}/clone \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "container_uuid": "string", "source_vmlogical_timestamp": 0, "spec_list": [ { "boot_config": { "boot_device_order": [ "string" ], "boot_device_type": "CDROM", "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "hardware_virtualization": true, "mac_addr": "string", "secure_boot": true, "uefi_boot": true }, "clone_affinity": true, "memory_mb": 0, "name": "string", "num_cores_per_vcpu": 0, "num_vcpus": 0, "override_network_config": true, "uuid": "string", "vm_nics": [ { "adapter_type": "E1000", "ip_address": "string", "ip_addresses": [ "string" ], "is_connected": true, "mac_address": "string", "model": "string", "network_uuid": "string", "nic_uuid": "string", "port_id": "string", "request_ip": true, "requested_ip_address": "string", "vlan_mode": "Access" } ] } ], "storage_container_uuid": "string", "uuid": "string", "vm_customization_config": { "datasource_type": "CONFIG_DRIVE_V2", "files_to_inject_list": [ { "destination_path": "string", "source_path": "string" } ], "fresh_install": true, "userdata": "string", "userdata_path": "string" } }'
{- "task_uuid": "string"
}
Create a Virtual Machine with specified configuration. If a UUID is specified for the Virtual Machine, this operation will be idempotent. This is an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
Create a Virtual Machine
allow_live_migrate | boolean |
object (create.dto.acropolis.BootConfigDTO) | |
cbr_not_capable_reason | string |
clear_affinity | boolean |
description | string |
gpus_assigned | boolean |
guest_driver_version | string |
guest_os | string |
ha_priority | integer <int64> |
host_uuid | string |
machine_type | string Enum: "PC" "PSERIES" "Q35" |
memory_mb | integer <int64> |
memory_reservation_mb | integer <int64> |
name | string |
num_cores_per_vcpu | integer <int32> |
num_vcpus | integer <int32> |
power_state | string Enum: "UNKNOWN" "OFF" "POWERING_ON" "ON" "SHUTTING_DOWN" "POWERING_OFF" "PAUSING" "PAUSED" "SUSPENDING" "SUSPENDED" "RESUMING" "RESETTING" "MIGRATING" |
Array of objects (create.dto.uhura.SerialPortConfigDTO) | |
storage_container_uuid | string |
timezone | string |
tools_installer_mounted | boolean |
tools_running_status | string Enum: "UNKNOWN" "GUEST_TOOLS_EXECUTING_SCRIPTS" "GUEST_TOOLS_NOT_RUNNING" "GUEST_TOOLS_RUNNING" |
uuid | string |
vcpu_reservation_hz | integer <int64> |
object (create.dto.acropolis.VMCustomizationConfigDTO) | |
Array of objects (create.dto.uhura.VmDiskInfoDTO) | |
Array of objects (create.dto.uhura.VMDiskDTO) | |
object | |
Array of objects (create.dto.uhura.GPUConfigDTO) | |
vm_logical_timestamp | integer <int64> |
Array of objects (create.dto.acropolis.VMNicSpecDTO) |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "allow_live_migrate": true, "boot": { "boot_device_order": [ "string" ], "boot_device_type": "CDROM", "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "hardware_virtualization": true, "mac_addr": "string", "secure_boot": true, "uefi_boot": true }, "cbr_not_capable_reason": "string", "clear_affinity": true, "description": "string", "gpus_assigned": true, "guest_driver_version": "string", "guest_os": "string", "ha_priority": 0, "host_uuid": "string", "machine_type": "PC", "memory_mb": 0, "memory_reservation_mb": 0, "name": "string", "num_cores_per_vcpu": 0, "num_vcpus": 0, "power_state": "UNKNOWN", "serial_ports": [ { "index": 0, "type": "NULL" } ], "storage_container_uuid": "string", "timezone": "string", "tools_installer_mounted": true, "tools_running_status": "UNKNOWN", "uuid": "string", "vcpu_reservation_hz": 0, "vm_customization_config": { "datasource_type": "CONFIG_DRIVE_V2", "files_to_inject_list": [ { "destination_path": "string", "source_path": "string" } ], "fresh_install": true, "userdata": "string", "userdata_path": "string" }, "vm_disk_info": [ { "datasource_uuid": "string", "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "flash_mode_enabled": true, "is_cdrom": true, "is_empty": true, "is_hot_remove_enabled": true, "is_scsi_passthrough": true, "is_thin_provisioned": true, "shared": true, "size": 0, "source_disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "storage_container_uuid": "string" } ], "vm_disks": [ { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "flash_mode_enabled": true, "is_cdrom": true, "is_empty": true, "is_scsi_pass_through": true, "is_thin_provisioned": true, "vm_disk_clone": { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "minimum_size": 0, "snapshot_group_uuid": "string", "storage_container_uuid": "string" }, "vm_disk_clone_external": { "external_disk_url": "string", "size": 0, "storage_container_uuid": "string" }, "vm_disk_create": { "size": 0, "storage_container_uuid": "string" }, "vm_disk_passthru_external": { "external_disk_url": "string", "storage_container_uuid": "string" } } ], "vm_features": { "property1": true, "property2": true }, "vm_gpus": [ { "assignable": true, "device_id": 0, "device_name": "string", "fraction": 0, "frame_buffer_size_bytes": 0, "gpu_mode": "UNUSED", "gpu_profile": "string", "gpu_type": "PASS_THROUGH_GRAPHICS", "gpu_vendor": "NVIDIA", "guest_driver_version": "string", "in_use": true, "licenses": [ "string" ], "max_instances_per_vm": 0, "max_resolution": "string", "num_virtual_display_heads": 0, "numa_node": 0, "sbdf": "string", "vm_uuids": [ "string" ] } ], "vm_logical_timestamp": 0, "vm_nics": [ { "adapter_type": "E1000", "ip_address": "string", "ip_addresses": [ "string" ], "is_connected": true, "mac_address": "string", "model": "string", "network_uuid": "string", "nic_uuid": "string", "port_id": "string", "request_ip": true, "requested_ip_address": "string", "vlan_mode": "Access" } ] }'
{- "task_uuid": "string"
}
Delete a NIC from a Virtual Machine. If the VM is running, the NIC is hot-removed from the VM. If the NIC to be removed is specified as the boot device in the boot configuration, the boot device configuration will be cleared as a side effect of removing the NIC. The logical timestamp can optionally be provided for consistency. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the Virtual Machine logical timestamp. The logical timestamp can be obtained from the Virtual Machine object. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
vm_uuid required | string UUID of the Virtual Machine |
nic_id required | string Virtual Machine NIC identifier (MAC address) |
vm_logical_timestamp | integer <int64> Virtual Machine Logical timestamp |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{vm_uuid}/nics/{nic_id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "task_uuid": "string"
}
Delete a Virtual Machine. This is an idempotent operation. If the Virtual Machine is currently powered on, it will be forcefully powered off. The logical timestamp can optionally be provided for consistency. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the Virtual Machine logical timestamp. The logical timestamp can be obtained from the Virtual Machine object. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
uuid required | string Id of the Virtual Machine |
delete_snapshots | boolean Delete Virtual Machine snapshots |
logical_timestamp | integer <int64> The Virtual logical timestamp |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "task_uuid": "string"
}
Detach disks from Virtual Machine.A disk drive may either be a regular disk drive, or a CD-ROM drive. Only CD-ROM drives may be empty. By default, regular disk drives are configured on the SCSI bus, and CD-ROM drives are configured on the IDE bus. The user may override this behavior with the deviceBus attribute. By default, a disk drive is placed on the first available bus slot. The user may override this behavior with the deviceIndex attribute. Disks on the SCSI bus may optionally be configured for passthrough on platforms that support iSCSI. When in passthrough mode, SCSI commands are passed directly to NDFS via iSCSI. When SCSI passthrough is disabled, the hypervisor provides a SCSI emulation layer, and treats the underlying iSCSI target as a block device. By default, SCSI passthrough is enabled for SCSI devices on supported platforms. If the disk image is cloned from an existing vmdisk or NFS file, the user may specify a minimum size for the resulting clone. This can be used to expand a disk image at clone time. If the VM is running, the disk is hot-added to the VM. Note that certain buses, like IDE, are not hot-pluggable. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
uuid required | string Id of the Virtual Machine |
Info about the virtual disks or CD-Roms to be detached
uuid | string |
Array of objects (create.dto.uhura.VmDiskInfoDTO) |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid}/disks/detach \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "uuid": "string", "vm_disks": [ { "datasource_uuid": "string", "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "flash_mode_enabled": true, "is_cdrom": true, "is_empty": true, "is_hot_remove_enabled": true, "is_scsi_passthrough": true, "is_thin_provisioned": true, "shared": true, "size": 0, "source_disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "storage_container_uuid": "string" } ] }'
{- "task_uuid": "string"
}
Details of a NIC in a Virtual Machine. Address assignments are not included by default as fetching these is an expensive operation. Address assignments can be included by setting include_address_assignments to true.
vm_uuid required | string Id of the Virtual Machine |
nic_id required | string Virtual Machine NIC identifier (MAC address) |
include_address_assignments | boolean Include address assignments |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{vm_uuid}/nics/{nic_id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "adapter_type": "E1000",
- "ip_address": "string",
- "ip_addresses": [
- "string"
], - "is_connected": true,
- "mac_address": "string",
- "model": "string",
- "network_uuid": "string",
- "nic_uuid": "string",
- "port_id": "string",
- "request_ip": true,
- "requested_ip_address": "string",
- "vlan_mode": "Access"
}
Get a list of Virtual Machines. Virtual Machine disk information and network information are not included by default as fetching these are expensive operations. These can be included by setting the include_vmdisk_config and include_vmnic_config flags respectively.
filter | string Filter criteria - semicolon for AND, comma for OR |
offset | integer <int64> offset - Default 0 |
length | integer <int64> Number of VMs to retrieve |
sort_order | string Sort order |
sort_attribute | string Sort Attribute |
include_vm_disk_config | boolean Whether to include Virtual Machine disk information. |
include_vm_nic_config | boolean Whether to include network information. |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "allow_live_migrate": true,
- "boot": {
- "boot_device_order": [
- "CDROM"
], - "boot_device_type": "CDROM",
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "hardware_virtualization": true,
- "mac_addr": "string",
- "secure_boot": true,
- "uefi_boot": true
}, - "cbr_not_capable_reason": "string",
- "clear_affinity": true,
- "description": "string",
- "gpus_assigned": true,
- "guest_driver_version": "string",
- "guest_os": "string",
- "ha_priority": 0,
- "host_uuid": "string",
- "machine_type": "PC",
- "memory_mb": 0,
- "memory_reservation_mb": 0,
- "name": "string",
- "num_cores_per_vcpu": 0,
- "num_vcpus": 0,
- "power_state": "UNKNOWN",
- "serial_ports": [
- {
- "index": 0,
- "type": "NULL"
}
], - "storage_container_uuid": "string",
- "timezone": "string",
- "tools_installer_mounted": true,
- "tools_running_status": "UNKNOWN",
- "uuid": "string",
- "vcpu_reservation_hz": 0,
- "vm_customization_config": {
- "datasource_type": "CONFIG_DRIVE_V2",
- "files_to_inject_list": [
- {
- "destination_path": "string",
- "source_path": "string"
}
], - "fresh_install": true,
- "userdata": "string",
- "userdata_path": "string"
}, - "vm_disk_info": [
- {
- "datasource_uuid": "string",
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "flash_mode_enabled": true,
- "is_cdrom": true,
- "is_empty": true,
- "is_hot_remove_enabled": true,
- "is_scsi_passthrough": true,
- "is_thin_provisioned": true,
- "shared": true,
- "size": 0,
- "source_disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "storage_container_uuid": "string"
}
], - "vm_disks": [
- {
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "flash_mode_enabled": true,
- "is_cdrom": true,
- "is_empty": true,
- "is_scsi_pass_through": true,
- "is_thin_provisioned": true,
- "vm_disk_clone": {
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "minimum_size": 0,
- "snapshot_group_uuid": "string",
- "storage_container_uuid": "string"
}, - "vm_disk_clone_external": {
- "external_disk_url": "string",
- "size": 0,
- "storage_container_uuid": "string"
}, - "vm_disk_create": {
- "size": 0,
- "storage_container_uuid": "string"
}, - "vm_disk_passthru_external": {
- "external_disk_url": "string",
- "storage_container_uuid": "string"
}
}
], - "vm_features": {
- "property1": true,
- "property2": true
}, - "vm_gpus": [
- {
- "assignable": true,
- "device_id": 0,
- "device_name": "string",
- "fraction": 0,
- "frame_buffer_size_bytes": 0,
- "gpu_mode": "UNUSED",
- "gpu_profile": "string",
- "gpu_type": "PASS_THROUGH_GRAPHICS",
- "gpu_vendor": "NVIDIA",
- "guest_driver_version": "string",
- "in_use": true,
- "licenses": [
- "string"
], - "max_instances_per_vm": 0,
- "max_resolution": "string",
- "num_virtual_display_heads": 0,
- "numa_node": 0,
- "sbdf": "string",
- "vm_uuids": [
- "string"
]
}
], - "vm_logical_timestamp": 0,
- "vm_nics": [
- {
- "adapter_type": "E1000",
- "ip_address": "string",
- "ip_addresses": [
- "string"
], - "is_connected": true,
- "mac_address": "string",
- "model": "string",
- "network_uuid": "string",
- "nic_uuid": "string",
- "port_id": "string",
- "request_ip": true,
- "requested_ip_address": "string",
- "vlan_mode": "Access"
}
]
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Get details of a specific Virtual Machines. Virtual Machine disk information and network information are not included by default as fetching these are expensive operations. These can be included by setting the include_vmdisk_config and include_vmnic_config flags respectively.
uuid required | string Id of the Virtual Machine |
include_vm_disk_config | boolean Whether to include Virtual Machine disk information. |
include_vm_nic_config | boolean Whether to include network information. |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "allow_live_migrate": true,
- "boot": {
- "boot_device_order": [
- "CDROM"
], - "boot_device_type": "CDROM",
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "hardware_virtualization": true,
- "mac_addr": "string",
- "secure_boot": true,
- "uefi_boot": true
}, - "cbr_not_capable_reason": "string",
- "clear_affinity": true,
- "description": "string",
- "gpus_assigned": true,
- "guest_driver_version": "string",
- "guest_os": "string",
- "ha_priority": 0,
- "host_uuid": "string",
- "machine_type": "PC",
- "memory_mb": 0,
- "memory_reservation_mb": 0,
- "name": "string",
- "num_cores_per_vcpu": 0,
- "num_vcpus": 0,
- "power_state": "UNKNOWN",
- "serial_ports": [
- {
- "index": 0,
- "type": "NULL"
}
], - "storage_container_uuid": "string",
- "timezone": "string",
- "tools_installer_mounted": true,
- "tools_running_status": "UNKNOWN",
- "uuid": "string",
- "vcpu_reservation_hz": 0,
- "vm_customization_config": {
- "datasource_type": "CONFIG_DRIVE_V2",
- "files_to_inject_list": [
- {
- "destination_path": "string",
- "source_path": "string"
}
], - "fresh_install": true,
- "userdata": "string",
- "userdata_path": "string"
}, - "vm_disk_info": [
- {
- "datasource_uuid": "string",
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "flash_mode_enabled": true,
- "is_cdrom": true,
- "is_empty": true,
- "is_hot_remove_enabled": true,
- "is_scsi_passthrough": true,
- "is_thin_provisioned": true,
- "shared": true,
- "size": 0,
- "source_disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "storage_container_uuid": "string"
}
], - "vm_disks": [
- {
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "flash_mode_enabled": true,
- "is_cdrom": true,
- "is_empty": true,
- "is_scsi_pass_through": true,
- "is_thin_provisioned": true,
- "vm_disk_clone": {
- "disk_address": {
- "device_bus": "SCSI",
- "device_index": 0,
- "device_uuid": "string",
- "disk_label": "string",
- "is_cdrom": true,
- "ndfs_filepath": "string",
- "vmdisk_uuid": "string",
- "volume_group_uuid": "string"
}, - "minimum_size": 0,
- "snapshot_group_uuid": "string",
- "storage_container_uuid": "string"
}, - "vm_disk_clone_external": {
- "external_disk_url": "string",
- "size": 0,
- "storage_container_uuid": "string"
}, - "vm_disk_create": {
- "size": 0,
- "storage_container_uuid": "string"
}, - "vm_disk_passthru_external": {
- "external_disk_url": "string",
- "storage_container_uuid": "string"
}
}
], - "vm_features": {
- "property1": true,
- "property2": true
}, - "vm_gpus": [
- {
- "assignable": true,
- "device_id": 0,
- "device_name": "string",
- "fraction": 0,
- "frame_buffer_size_bytes": 0,
- "gpu_mode": "UNUSED",
- "gpu_profile": "string",
- "gpu_type": "PASS_THROUGH_GRAPHICS",
- "gpu_vendor": "NVIDIA",
- "guest_driver_version": "string",
- "in_use": true,
- "licenses": [
- "string"
], - "max_instances_per_vm": 0,
- "max_resolution": "string",
- "num_virtual_display_heads": 0,
- "numa_node": 0,
- "sbdf": "string",
- "vm_uuids": [
- "string"
]
}
], - "vm_logical_timestamp": 0,
- "vm_nics": [
- {
- "adapter_type": "E1000",
- "ip_address": "string",
- "ip_addresses": [
- "string"
], - "is_connected": true,
- "mac_address": "string",
- "model": "string",
- "network_uuid": "string",
- "nic_uuid": "string",
- "port_id": "string",
- "request_ip": true,
- "requested_ip_address": "string",
- "vlan_mode": "Access"
}
]
}
Get list of NICs in a Virtual Machine. Address assignments are not included by default as fetching these is an expensive operation. Address assignments can be included by setting include_address_assignments to true.
uuid required | string UUID of the Virtual Machine |
include_address_assignments | boolean Include address assignments |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid}/nics \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "adapter_type": "E1000",
- "ip_address": "string",
- "ip_addresses": [
- "string"
], - "is_connected": true,
- "mac_address": "string",
- "model": "string",
- "network_uuid": "string",
- "nic_uuid": "string",
- "port_id": "string",
- "request_ip": true,
- "requested_ip_address": "string",
- "vlan_mode": "Access"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Mount and unmount guest tools on a given Virtual Machine. If override_guest is set to false and no empty CdRom is available on the guest VM, then the mount operation will fail. If override_guest is set to true then the mount operation succeeds by unmounting a non-empty CdRom.This is an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.This API works only for Esxi.
uuid required | string UUID of the Virtual Machine |
VM Guest Tools Info
operation | string Enum: "MOUNT" "UNMOUNT" |
override_guest | boolean |
uuid | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid}/manage_vm_guest_tools \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "operation": "MOUNT", "override_guest": true, "uuid": "string" }'
{- "task_uuid": "string"
}
uuid required | string Id of the Virtual Machine |
Update disk for VM
uuid | string |
Array of objects (update.dto.uhura.VMDiskDTO) | |
vm_logical_timestamp | integer <int64> |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid}/disks/update \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "uuid": "string", "vm_disks": [ { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "flash_mode_enabled": true, "is_cdrom": true, "is_empty": true, "is_scsi_pass_through": true, "is_thin_provisioned": true, "vm_disk_clone": { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "minimum_size": 0, "snapshot_group_uuid": "string", "storage_container_uuid": "string" }, "vm_disk_clone_external": { "external_disk_url": "string", "size": 0, "storage_container_uuid": "string" }, "vm_disk_create": { "size": 0, "storage_container_uuid": "string" }, "vm_disk_passthru_external": { "external_disk_url": "string", "storage_container_uuid": "string" } } ], "vm_logical_timestamp": 0 }'
{- "task_uuid": "string"
}
Restore a Virtual Machine to a snapshotted state. If the VM is currently running, it will be powered off. Since Virtual Machine snapshots do not include the Virtual Machine memory image, the Virtual Machine will remain powered off after the restore is complete. A Virtual Machine snapshot may no longer be compatible with the current virtual network configuration. In this case, the user may choose not to restore the Virtual Machine s network adpaters using the restoreNetworkConfig keyword argument. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
uuid required | string Uuid of the Virtual Machine |
Restore Virtual Machine
restore_network_configuration | boolean |
snapshot_uuid | string |
uuid | string |
vm_logical_time_stamp | integer <int64> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid}/restore \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "restore_network_configuration": true, "snapshot_uuid": "string", "uuid": "string", "vm_logical_time_stamp": 0 }'
{- "task_uuid": "string"
}
Set power state of a Virtual Machine. If the Virtual Machine is being powered on and no host is specified, the scheduler will pick the one with the most available CPU and memory that can support the Virtual Machine. Note that no such host may not be available. If the Virtual Machine is being power cycled, a different host can be specified to start it on. The logical timestamp can optionally be provided for consistency. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the Virtual Machine logical timestamp. The logical timestamp can be obtained from the Virtual Machine object. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
uuid required | string Id of the Virtual Machine |
Virtual Machine Power State Info
host_uuid | string |
transition | string Enum: "ON" "OFF" "POWERCYCLE" "RESET" "PAUSE" "SUSPEND" "RESUME" "SAVE" "ACPI_SHUTDOWN" "ACPI_REBOOT" |
uuid | string |
vm_logical_timestamp | integer <int64> |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid}/set_power_state \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "host_uuid": "string", "transition": "ON", "uuid": "string", "vm_logical_timestamp": 0 }'
{- "task_uuid": "string"
}
Update a NIC for a Virtual Machine. A VM NIC must be associated with a MAC address. It is not possible to change this association as the MAC address acts as the NIC s identifier. If the virtual network is managed (see POST /networks/), the IPv4 address of the NIC can be updated. If the VM is running, the NIC is hot-added to the VM. The logical timestamp can optionally be provided for consistency. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the Virtual Machine logical timestamp. The logical timestamp can be obtained from the Virtual Machine object. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API.
uuid required | string UUID of the Virtual Machine |
nic_id required | string Virtual Machine NIC identifier (MAC address) |
NIC Config Update Info
nic_id | string |
object (update.dto.acropolis.VMNicSpecDTO) | |
uuid | string |
vm_logical_timestamp | integer <int64> |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid}/nics/{nic_id} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "nic_id": "string", "nic_spec": { "adapter_type": "E1000", "ip_address": "string", "ip_addresses": [ "string" ], "is_connected": true, "mac_address": "string", "model": "string", "network_uuid": "string", "nic_uuid": "string", "port_id": "string", "request_ip": true, "requested_ip_address": "string", "vlan_mode": "Access" }, "uuid": "string", "vm_logical_timestamp": 0 }'
{- "task_uuid": "string"
}
Update a Virtual Machine. Field that are not set or are not specified are ignored. Note that some attributes may not be modifiable while the Virtual Machine is running. For instance, the KVM hypervisor does not support CPU or memory hot-plug. The hwclockTimezone attribute specifies the VM s hardware clock timezone. Most operating systems assume the system clock is UTC, but some (like Windows) expect the local timezone. Changes to the clock timezone only take effect after a full Virtual Machine power cycle. This API can be used to reclaim memory from guests using a balloon driver. It is not currently possible to return ballooned memory to a guest. The attempt to reclaim memory may fail if the balloon driver is not installed, or is unable to allocate the requested amount of memory from the guest OS. In this case, the Virtual Machine s memory reservation will be restored to its value from before the balloon attempt. If a logical timestamp is specified, then this operation will be rejected if the logical timestamp specified is not the value of the Virtual Machine logical timestamp. The logical timestamp can be obtained from the Virtual Machine object. This is also an asynchronous operation that results in the creation of a task object. The UUID of this task object is returned as the response of this operation. This task can be monitored by using the /tasks/poll API. The VM disks cannot be updated using this api. Please use v2.0 vms/uuid/disks/update API.
uuid required | string Id of the Virtual Machine |
Virtual Machine Update Info
allow_live_migrate | boolean |
object (update.dto.acropolis.BootConfigDTO) | |
cbr_not_capable_reason | string |
clear_affinity | boolean |
description | string |
gpus_assigned | boolean |
guest_driver_version | string |
guest_os | string |
ha_priority | integer <int64> |
host_uuid | string |
machine_type | string Enum: "PC" "PSERIES" "Q35" |
memory_mb | integer <int64> |
memory_reservation_mb | integer <int64> |
name | string |
num_cores_per_vcpu | integer <int32> |
num_vcpus | integer <int32> |
power_state | string Enum: "UNKNOWN" "OFF" "POWERING_ON" "ON" "SHUTTING_DOWN" "POWERING_OFF" "PAUSING" "PAUSED" "SUSPENDING" "SUSPENDED" "RESUMING" "RESETTING" "MIGRATING" |
Array of objects (update.dto.uhura.SerialPortConfigDTO) | |
storage_container_uuid | string |
timezone | string |
tools_installer_mounted | boolean |
tools_running_status | string Enum: "UNKNOWN" "GUEST_TOOLS_EXECUTING_SCRIPTS" "GUEST_TOOLS_NOT_RUNNING" "GUEST_TOOLS_RUNNING" |
uuid | string |
vcpu_reservation_hz | integer <int64> |
object (update.dto.acropolis.VMCustomizationConfigDTO) | |
Array of objects (update.dto.uhura.VmDiskInfoDTO) | |
Array of objects (update.dto.uhura.VMDiskDTO) | |
object | |
Array of objects (update.dto.uhura.GPUConfigDTO) | |
vm_logical_timestamp | integer <int64> |
Array of objects (update.dto.acropolis.VMNicSpecDTO) |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vms/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "allow_live_migrate": true, "boot": { "boot_device_order": [ "string" ], "boot_device_type": "CDROM", "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "hardware_virtualization": true, "mac_addr": "string", "secure_boot": true, "uefi_boot": true }, "cbr_not_capable_reason": "string", "clear_affinity": true, "description": "string", "gpus_assigned": true, "guest_driver_version": "string", "guest_os": "string", "ha_priority": 0, "host_uuid": "string", "machine_type": "PC", "memory_mb": 0, "memory_reservation_mb": 0, "name": "string", "num_cores_per_vcpu": 0, "num_vcpus": 0, "power_state": "UNKNOWN", "serial_ports": [ { "index": 0, "type": "NULL" } ], "storage_container_uuid": "string", "timezone": "string", "tools_installer_mounted": true, "tools_running_status": "UNKNOWN", "uuid": "string", "vcpu_reservation_hz": 0, "vm_customization_config": { "datasource_type": "CONFIG_DRIVE_V2", "files_to_inject_list": [ { "destination_path": "string", "source_path": "string" } ], "fresh_install": true, "userdata": "string", "userdata_path": "string" }, "vm_disk_info": [ { "datasource_uuid": "string", "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "flash_mode_enabled": true, "is_cdrom": true, "is_empty": true, "is_hot_remove_enabled": true, "is_scsi_passthrough": true, "is_thin_provisioned": true, "shared": true, "size": 0, "source_disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "storage_container_uuid": "string" } ], "vm_disks": [ { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "flash_mode_enabled": true, "is_cdrom": true, "is_empty": true, "is_scsi_pass_through": true, "is_thin_provisioned": true, "vm_disk_clone": { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "minimum_size": 0, "snapshot_group_uuid": "string", "storage_container_uuid": "string" }, "vm_disk_clone_external": { "external_disk_url": "string", "size": 0, "storage_container_uuid": "string" }, "vm_disk_create": { "size": 0, "storage_container_uuid": "string" }, "vm_disk_passthru_external": { "external_disk_url": "string", "storage_container_uuid": "string" } } ], "vm_features": { "property1": true, "property2": true }, "vm_gpus": [ { "assignable": true, "device_id": 0, "device_name": "string", "fraction": 0, "frame_buffer_size_bytes": 0, "gpu_mode": "UNUSED", "gpu_profile": "string", "gpu_type": "PASS_THROUGH_GRAPHICS", "gpu_vendor": "NVIDIA", "guest_driver_version": "string", "in_use": true, "licenses": [ "string" ], "max_instances_per_vm": 0, "max_resolution": "string", "num_virtual_display_heads": 0, "numa_node": 0, "sbdf": "string", "vm_uuids": [ "string" ] } ], "vm_logical_timestamp": 0, "vm_nics": [ { "adapter_type": "E1000", "ip_address": "string", "ip_addresses": [ "string" ], "is_connected": true, "mac_address": "string", "model": "string", "network_uuid": "string", "nic_uuid": "string", "port_id": "string", "request_ip": true, "requested_ip_address": "string", "vlan_mode": "Access" } ] }'
{- "task_uuid": "string"
}
uuid required | string UUID of the Volume Group |
Virtual Machine attach configuration
index | integer <int32> |
logical_timestamp | integer <int64> |
operation | string Enum: "ATTACH" "DETACH" |
uuid | string |
vm_logical_timestamp | integer <int64> |
vm_uuid | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/{uuid}/attach \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "index": 0, "logical_timestamp": 0, "operation": "ATTACH", "uuid": "string", "vm_logical_timestamp": 0, "vm_uuid": "string" }'
{- "task_uuid": "string"
}
uuid required | string UUID of the source Volume Group |
Clone a Volume Group
created_by | string |
Array of objects (create.dto.acropolis.volumegroups.ClientAuthenticationDTO) | |
iscsi_target | string |
iscsi_target_prefix | string |
load_balance_vm_attachments | boolean |
logical_timestamp | integer <int64> |
name | string |
source_volume_group_uuid | string |
uuid | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/{uuid}/clone \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "created_by": "string", "enabled_authentications": [ { "auth_type": "CHAP", "password": "string" } ], "iscsi_target": "string", "iscsi_target_prefix": "string", "load_balance_vm_attachments": true, "logical_timestamp": 0, "name": "string", "source_volume_group_uuid": "string", "uuid": "string" }'
{- "task_uuid": "string"
}
uuid required | string UUID of the Volume Group |
Volume Group detach configuration
object (create.dto.acropolis.volumegroups.IscsiClientDTO) | |
iscsi_client_ip | string |
iscsi_initiator | string |
logical_timestamp | integer <int64> |
operation | string Enum: "ATTACH" "DETACH" |
uuid | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/{uuid}/close \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "iscsi_client": { "client_address": "string", "enabled_authentications": [ { "auth_type": "CHAP", "password": "string" } ], "uuid": "string" }, "iscsi_client_ip": "string", "iscsi_initiator": "string", "logical_timestamp": 0, "operation": "ATTACH", "uuid": "string" }'
{- "value": true
}
Create a Volume Group
Array of objects (create.dto.acropolis.volumegroups.IscsiClientDTO) | |
created_by | string |
description | string |
Array of objects (create.dto.acropolis.volumegroups.VolumeDiskCreateSpecDTO) | |
Array of objects (create.dto.acropolis.volumegroups.ClientAuthenticationDTO) | |
flash_mode_enabled | boolean |
is_hidden | boolean |
is_shared | boolean |
iscsi_initiator_name_list | Array of strings |
iscsi_target | string |
iscsi_target_prefix | string |
load_balance_vm_attachments | boolean |
name | string |
usage_type | string Enum: "UNKNOWN" "USER" "INTERNAL" "TEMPORARY" "BACKUP_TARGET" |
uuid | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "attached_clients": [ { "client_address": "string", "enabled_authentications": [ { "auth_type": "CHAP", "password": "string" } ], "uuid": "string" } ], "created_by": "string", "description": "string", "disk_list": [ { "clone_config": { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "minimum_size": 0, "snapshot_group_uuid": "string", "storage_container_uuid": "string" }, "clone_spec": { "container_uuid": "string", "image_path": "string", "minimum_size": 0, "minimum_size_mb": 0, "ndfs_filepath": "string", "snapshot_group_id": "string", "vm_disk_uuid": "string", "vmdisk_uuid": "string" }, "create_config": { "size": 0, "storage_container_uuid": "string" }, "create_spec": { "container_id": 0, "container_name": "string", "container_uuid": "string", "size": 0, "size_mb": 0 }, "index": 0, "volume_group_uuid": "string" } ], "enabled_authentications": [ { "auth_type": "CHAP", "password": "string" } ], "flash_mode_enabled": true, "is_hidden": true, "is_shared": true, "iscsi_initiator_name_list": [ "string" ], "iscsi_target": "string", "iscsi_target_prefix": "string", "load_balance_vm_attachments": true, "name": "string", "usage_type": "UNKNOWN", "uuid": "string" }'
{- "task_uuid": "string"
}
Creates a Volume Disk with specified configuration.
uuid required | string UUID of the Volume Group |
Create a Volume Disk
object (create.dto.uhura.VmDiskCloneDTO) | |
object (create.dto.acropolis.VMDiskSpecCloneDTO) | |
object (create.dto.uhura.VmDiskCreateDTO) | |
object (create.dto.acropolis.VmDiskSpecCreateDTO) | |
index | integer <int32> |
volume_group_uuid | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/{uuid}/disks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "clone_config": { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "minimum_size": 0, "snapshot_group_uuid": "string", "storage_container_uuid": "string" }, "clone_spec": { "container_uuid": "string", "image_path": "string", "minimum_size": 0, "minimum_size_mb": 0, "ndfs_filepath": "string", "snapshot_group_id": "string", "vm_disk_uuid": "string", "vmdisk_uuid": "string" }, "create_config": { "size": 0, "storage_container_uuid": "string" }, "create_spec": { "container_id": 0, "container_name": "string", "container_uuid": "string", "size": 0, "size_mb": 0 }, "index": 0, "volume_group_uuid": "string" }'
{- "task_uuid": "string"
}
Delete a Volume Disk with specified configuration.
uuid required | string UUID of the Volume Group |
index required | integer <int32> Volume Group index of the disk |
logical_timestamp | integer <int64> The logical timestamp |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/{uuid}/disks/{index} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "task_uuid": "string"
}
uuid required | string UUID of the Volume Group |
Virtual Machine detach configuration
index | integer <int32> |
logical_timestamp | integer <int64> |
operation | string Enum: "ATTACH" "DETACH" |
uuid | string |
vm_logical_timestamp | integer <int64> |
vm_uuid | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/{uuid}/detach \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "index": 0, "logical_timestamp": 0, "operation": "ATTACH", "uuid": "string", "vm_logical_timestamp": 0, "vm_uuid": "string" }'
{- "task_uuid": "string"
}
filter_criteria | string Filter criteria |
detailed_summary | boolean Detailed summary |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/health_check_summary \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "checks_in_error": {
- "property1": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}, - "property2": {
- "cluster_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
], - "node_level": [
- {
- "entity_name": "string",
- "entity_uuid": "string",
- "message": "string"
}
]
}
}, - "detailed_check_summary": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "entity_type": "PAGE",
- "filter_criteria": "string",
- "health_summary": {
- "property1": 0,
- "property2": 0
}
}
If start time and end time are included in the query string, then historical stats are retrieved. Otherwise, the latest stats are retrieved.
uuid required | string Uuid of the VolumeGroup |
metrics required | Array of strings List of metrics |
start_time_usecs | integer <int64> Start time in microseconds |
end_time_usecs | integer <int64> End time in microseconds |
interval_in_secs | integer <int32> Sampling interval of stats |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/{uuid}/stats \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "stats_specific_responses": [
- {
- "interval_in_secs": 0,
- "message": "string",
- "metric": "string",
- "start_time_in_usecs": 0,
- "successful": true,
- "values": [
- 0
]
}
]
}
uuid required | string UUID of the Volume Group |
Update Volume Group
Array of objects (update.dto.acropolis.volumegroups.IscsiClientDTO) | |
created_by | string |
description | string |
Array of objects (update.dto.acropolis.volumegroups.ClientAuthenticationDTO) | |
flash_mode_enabled | boolean |
is_hidden | boolean |
is_shared | boolean |
iscsi_initiator_name_list | Array of strings |
iscsi_target | string |
iscsi_target_prefix | string |
load_balance_vm_attachments | boolean |
logical_timestamp | integer <int64> |
name | string |
usage_type | string Enum: "UNKNOWN" "USER" "INTERNAL" "TEMPORARY" "BACKUP_TARGET" |
uuid | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "attached_clients": [ { "client_address": "string", "enabled_authentications": [ { "auth_type": "CHAP", "password": "string" } ], "uuid": "string" } ], "created_by": "string", "description": "string", "enabled_authentications": [ { "auth_type": "CHAP", "password": "string" } ], "flash_mode_enabled": true, "is_hidden": true, "is_shared": true, "iscsi_initiator_name_list": [ "string" ], "iscsi_target": "string", "iscsi_target_prefix": "string", "load_balance_vm_attachments": true, "logical_timestamp": 0, "name": "string", "usage_type": "UNKNOWN", "uuid": "string" }'
{- "attachment_list": [
- {
- "client_uuid": "string",
- "enabled_authentications": [
- {
- "auth_type": "CHAP",
- "password": "string"
}
], - "initiator_ip_address": "string",
- "iscsi_initiator_name": "string",
- "vm_uuid": "string"
}
], - "created_by": "string",
- "description": "string",
- "disk_list": [
- {
- "container_id": 0,
- "container_uuid": "string",
- "flash_mode_enabled": true,
- "index": 0,
- "storage_container_id": 0,
- "storage_container_uuid": "string",
- "vmdisk_path": "string",
- "vmdisk_size_bytes": 0,
- "vmdisk_size_mb": 0,
- "vmdisk_uuid": "string"
}
], - "enabled_authentications": [
- {
- "auth_type": "CHAP",
- "password": "string"
}
], - "flash_mode_enabled": true,
- "is_deleted": true,
- "is_hidden": true,
- "is_shared": true,
- "iscsi_target": "string",
- "last_modified_timestamp_usecs": 0,
- "load_balance_vm_attachments": true,
- "logical_timestamp": 0,
- "name": "string",
- "usage_type": "UNKNOWN",
- "uuid": "string"
}
uuid required | string UUID of the Volume Group |
Volume Group attach configuration
object (create.dto.acropolis.volumegroups.IscsiClientDTO) | |
iscsi_client_ip | string |
iscsi_initiator | string |
logical_timestamp | integer <int64> |
operation | string Enum: "ATTACH" "DETACH" |
uuid | string |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/{uuid}/open \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "iscsi_client": { "client_address": "string", "enabled_authentications": [ { "auth_type": "CHAP", "password": "string" } ], "uuid": "string" }, "iscsi_client_ip": "string", "iscsi_initiator": "string", "logical_timestamp": 0, "operation": "ATTACH", "uuid": "string" }'
{- "value": true
}
uuid required | string UUID of the Volume Group |
logical_timestamp | integer <int64> The logical timestamp |
curl --request DELETE \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "task_uuid": "string"
}
include_disk_size | boolean Whether to include disk sizes, true by default |
include_disk_path | boolean Whether to include disk paths, true by default |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "attachment_list": [
- {
- "client_uuid": "string",
- "enabled_authentications": [
- {
- "auth_type": "CHAP",
- "password": "string"
}
], - "initiator_ip_address": "string",
- "iscsi_initiator_name": "string",
- "vm_uuid": "string"
}
], - "created_by": "string",
- "description": "string",
- "disk_list": [
- {
- "container_id": 0,
- "container_uuid": "string",
- "flash_mode_enabled": true,
- "index": 0,
- "storage_container_id": 0,
- "storage_container_uuid": "string",
- "vmdisk_path": "string",
- "vmdisk_size_bytes": 0,
- "vmdisk_size_mb": 0,
- "vmdisk_uuid": "string"
}
], - "enabled_authentications": [
- {
- "auth_type": "CHAP",
- "password": "string"
}
], - "flash_mode_enabled": true,
- "is_deleted": true,
- "is_hidden": true,
- "is_shared": true,
- "iscsi_target": "string",
- "last_modified_timestamp_usecs": 0,
- "load_balance_vm_attachments": true,
- "logical_timestamp": 0,
- "name": "string",
- "usage_type": "UNKNOWN",
- "uuid": "string"
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
uuid required | string UUID of the Volume Group |
include_disk_size | boolean Whether to include disk sizes |
include_disk_path | boolean Whether to include disk paths |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "attachment_list": [
- {
- "client_uuid": "string",
- "enabled_authentications": [
- {
- "auth_type": "CHAP",
- "password": "string"
}
], - "initiator_ip_address": "string",
- "iscsi_initiator_name": "string",
- "vm_uuid": "string"
}
], - "created_by": "string",
- "description": "string",
- "disk_list": [
- {
- "container_id": 0,
- "container_uuid": "string",
- "flash_mode_enabled": true,
- "index": 0,
- "storage_container_id": 0,
- "storage_container_uuid": "string",
- "vmdisk_path": "string",
- "vmdisk_size_bytes": 0,
- "vmdisk_size_mb": 0,
- "vmdisk_uuid": "string"
}
], - "enabled_authentications": [
- {
- "auth_type": "CHAP",
- "password": "string"
}
], - "flash_mode_enabled": true,
- "is_deleted": true,
- "is_hidden": true,
- "is_shared": true,
- "iscsi_target": "string",
- "last_modified_timestamp_usecs": 0,
- "load_balance_vm_attachments": true,
- "logical_timestamp": 0,
- "name": "string",
- "usage_type": "UNKNOWN",
- "uuid": "string"
}
Updates a Volume Disk with specified configuration.
uuid required | string UUID of the Volume Group |
Update a Volume Disk
object (update.dto.uhura.VmDiskCloneDTO) | |
object (update.dto.acropolis.VMDiskSpecCloneDTO) | |
flash_mode_enabled | boolean |
index | integer <int32> |
object (update.dto.acropolis.volumegroups.VolumeDiskUpdateDTO_UpgradeSpec) | |
volume_group_uuid | string |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/volume_groups/{uuid}/disks \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "clone": { "disk_address": { "device_bus": "SCSI", "device_index": 0, "device_uuid": "string", "disk_label": "string", "is_cdrom": true, "ndfs_filepath": "string", "vmdisk_uuid": "string", "volume_group_uuid": "string" }, "minimum_size": 0, "snapshot_group_uuid": "string", "storage_container_uuid": "string" }, "clone_spec": { "container_uuid": "string", "image_path": "string", "minimum_size": 0, "minimum_size_mb": 0, "ndfs_filepath": "string", "snapshot_group_id": "string", "vm_disk_uuid": "string", "vmdisk_uuid": "string" }, "flash_mode_enabled": true, "index": 0, "upgrade_spec": { "container_uuid": "string", "preserve_data": true, "size": 0, "size_mb": 0, "storage_container_uuid": "string" }, "volume_group_uuid": "string" }'
{- "container_id": 0,
- "container_uuid": "string",
- "flash_mode_enabled": true,
- "index": 0,
- "storage_container_id": 0,
- "storage_container_uuid": "string",
- "vmdisk_path": "string",
- "vmdisk_size_bytes": 0,
- "vmdisk_size_mb": 0,
- "vmdisk_uuid": "string"
}
Get a VStore with the specified uuid.
uuid required | string Uuid of the VStore |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vstores/{uuid} \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "backedup": true,
- "container_id": 0,
- "container_uuid": "string",
- "id": 0,
- "is_backup": true,
- "marked_for_removal": true,
- "name": "string",
- "protection_domain": "string",
- "storage_container_id": 0,
- "storage_container_uuid": "string",
- "uuid": "string",
- "vm_level_consistent": true
}
Get the list of VStores configured in the cluster.
uuids | Array of strings VStore uuids |
names | Array of strings VStore names |
include_deleted | boolean Include deleted |
curl --request GET \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vstores \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "entities": [
- {
- "backedup": true,
- "container_id": 0,
- "container_uuid": "string",
- "id": 0,
- "is_backup": true,
- "marked_for_removal": true,
- "name": "string",
- "protection_domain": "string",
- "storage_container_id": 0,
- "storage_container_uuid": "string",
- "uuid": "string",
- "vm_level_consistent": true
}
], - "error_info": {
- "count": 0,
- "entity_list": [
- "string"
], - "message": "string"
}, - "metadata": {
- "count": 0,
- "end_index": 0,
- "filter_criteria": "string",
- "grand_total_entities": 0,
- "next_cursor": "string",
- "page": 0,
- "previous_cursor": "string",
- "search_string": "string",
- "sort_criteria": "string",
- "start_index": 0,
- "total_entities": 0
}
}
Protect a VStore with the specified id.
uuid required | string Uuid of the VStore |
vm_level_consistency | boolean Create vm level consistent snapshots for the vStore |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vstores/{uuid}/protect \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "backedup": true,
- "container_id": 0,
- "container_uuid": "string",
- "id": 0,
- "is_backup": true,
- "marked_for_removal": true,
- "name": "string",
- "protection_domain": "string",
- "storage_container_id": 0,
- "storage_container_uuid": "string",
- "uuid": "string",
- "vm_level_consistent": true
}
Protect a VStore with the specified uuid.
uuid required | string Uuid of the VStore |
vm_level_consistency required | boolean Create vm level consistent snapshots for the vStore |
curl --request PUT \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vstores/{uuid}/update_protection_mode \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "backedup": true,
- "container_id": 0,
- "container_uuid": "string",
- "id": 0,
- "is_backup": true,
- "marked_for_removal": true,
- "name": "string",
- "protection_domain": "string",
- "storage_container_id": 0,
- "storage_container_uuid": "string",
- "uuid": "string",
- "vm_level_consistent": true
}
Unprotect a VStore with the specified id.
uuid required | string Uuid of the VStore |
curl --request POST \ --url https://any_cvm_ip:9440/PrismGateway/services/rest/v2.0/vstores/{uuid}/unprotect \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \
{- "backedup": true,
- "container_id": 0,
- "container_uuid": "string",
- "id": 0,
- "is_backup": true,
- "marked_for_removal": true,
- "name": "string",
- "protection_domain": "string",
- "storage_container_id": 0,
- "storage_container_uuid": "string",
- "uuid": "string",
- "vm_level_consistent": true
}