Dell EMC PowerStore REST API Developers Guide June 2020 Rev.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2020 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents Additional Resources...................................................................................................................................................................5 1 Overview..................................................................................................................................... 6 The PowerStore Management REST API..........................................................................................................................
Deleting a resource instance..............................................................................................................................................35 Performing an instance-level resource-specific action.................................................................................................. 36 Performing a class-level action..........................................................................................................................................
Additional Resources As part of an improvement effort, revisions of the software and hardware are periodically released. Some functions that are described in this document are not supported by all versions of the software or hardware currently in use. The product release notes provide the most up-to-date information about product features. Contact your technical support professional if a product does not function properly or does not function as described in this document.
1 Overview The PowerStore Management REST API The PowerStore Management REST API is a set of resources (objects), operations, and attributes that provide interactive, scripted, and programmatic management control of the PowerStore cluster. Here are some examples of what you can do with the REST API: • • • • • • Provision new cluster components, such as appliances and volumes. Configure replication destinations and sessions, and rules. Fail over and fail back an appliance.
JSON data exchange format JavaScript Object Notation (JSON) is a text-based, platform-independent data-exchange format that is easy for humans and machines to read and write. It consists of two structures: • • A set of name:value pairs enclosed by curly brackets. A list of values enclosed by square brackets. This structure is used when the value in a name:value pair is an array.
2 REST request components HTTP request headers The following table describes the HTTP request headers used by the PowerStore Management REST API. The API uses these headers in standard ways. HTTP header Value Description Accept: application/json Format of the body content desired in the response. All requests use Accept: application/json, which is the default and only value accepted. Content-Type: application/json Body content type of the request.
Table 1. Basic patterns in the REST API(continued) URI pattern HTTP Operations Description Instance action URI POST Performs the operation specified by for the specified resource instance. POST Performs the operation specified by for the specified non-singleton resource type. /api/rest/// Class-level action URI /api/rest// NOTE: URI parameters cannot contain slashes (/) or other special characters.
Request parameter Applicable request types Collection queries order Description Specifies how to sort response data. You can sort response data in ascending or descending order based on one of the following: • • • The attributes of the queried resource type. The attributes of a resource type that is embedded in the primary resource type or related through a foreign key. A computed attribute. For more information, see Sorting response data on page 28.
Response [ { "id":"37583ff1-b0fe-41f2-9b3d-e5e5d2e5e525", "severity":"Info" }, { "id":"63d21fb9-897d-4d07-983f-0478436755b6", "severity":"Info" }, { } "id":"ab9175c4-1ded-473e-b22d-63ac1154937f", "severity":"Info" . . . Using the order request parameter The following request uses an order expression to sort alert instances by severity: Request Response GET https://1.2.3.
• For number or boolean values: { } :, :, . . . For IP, string, or datetime values: • { } :"", :"", . . .
3 REST responses Response components Each response to a REST API request consists of a response header, HTTP status code (in the response header), and JSON response body, if applicable: • • • The response header contains metadata about the response being sent. The HTTP status code in the response header indicates whether a request is successful or unsuccessful. ○ An HTTP status code in the 2xx family, such as 200 OK or 201 Created, indicates a correctly processed request.
Table 3. HTTP status codes in the REST API Status code Name Applies to Description 200 OK All of the following: Successful request. • • For a GET request, the response body contains the requested resource. For an action POST and PATCH request, the response body contains the output arguments. • 201 Created GET requests Action PATCH requests with output data Action POST requests with output data POST requests for creating resources Successful request.
Table 3. HTTP status codes in the REST API(continued) Status code Name Applies to Description Example causes: • • • The system is out of space. A range error occurred. There are inconsistent properties on a POST or PATCH 500 Internal Server Error All requests Internal error. 503 Service Unavailable All requests The REST service is temporarily unavailable. Wait and try the request again.
Example GET instance response for an event The following example illustrates an instance resource. It shows an instance resource returned in response to a GET instance request for the event resource type with an identifier of 299a2f56-fea7-4e85-af0d-992294526911. Spaces outside the quoted strings are used for readability, and are not significant. Request Response GET https://1.2.3.
Example Deletion response for a local_user The following example returns a job resource instance in response to a successful asynchronous DELETE request. Request Response DELETE https://1.2.3.4/api/rest/local_user/4?is_async=true { } "id": "476c903a-1bc2-4370-9a4b-426594ed9604" Error response An error response is returned in response to an unsuccessful request; that is, a request that returns a 4xx or 5xx HTTP status code.
4 JSON encodings JSON base value encodings The following table shows the JSON encodings for each base type: NOTE: A property that has no value appears as the type null. Type name JSON definition Format after "": Example Notes short type: integer "drive_count":600 N/A "answer": 42 N/A "size": 123456789 N/A "progress": 99.9 N/A "throughput": 123456.78 N/A Use \ to escape the quote (") and control characters.
Type name JSON definition Format after "": Example a client (to hide typed input). This is handled differently on the server (for example, the values are not logged). format: password ipaddress type: string format: ipaddress Notes String containing an IPv4 address, IPv6 address, or host name. "mgmtAddr":"128.222. In this API, some attributes 1.2" support IPv4 only, while others support both IPv4 and IPv6. Some attributes also support DNS names.
A list with three values "addresses":["1.2.3.4","5.6.7.8","4.3.2.
5 Managing a REST API session Connecting and authenticating All requests to the REST API must be authenticated. The REST API uses the standard HTTP Basic access authentication mechanism to authenticate REST requests. The same users are valid for REST or GUI access.
Attribute Description is_built_in_user Indicates whether the user is a system-defined user, such as admin.
6 Querying a resource Pagination When you query a resource, the server limits the size of the returned collection by default. This collection is limited to the number of instances up to a specified pagination limit, which defaults to 100. If the requested collection has fewer instances than this limit, the response contains the status code 200 OK and all requested instances in its body. When the requested collection is larger than the limit, the response status code changes to 206 (Partial Content).
URI pattern /api/rest/ where is the resource type for the collection you want to return. For additional functionality, such as filtering instances, you can append one or more request parameters to the URI. Body Empty. If the request succeeds, the server returns a 200 OK HTTP status code and a collection resource in the response body. If the request does not succeed, the server returns a 4xx or 5xx HTTP status code and an error response.
Headers Operation Accept: application/json Authorization: GET URI pattern /api/rest// where: • • is the resource type of the desired instance. is the unique identifier of the desired instance. For additional functionality, such as returning specific attributes, you can append one or more request parameters to the URI. Body Empty. If the request succeeds, the server returns a 200 OK HTTP status code and an instance resource in the response body.
You can use nested notation syntax ((...) ) in a select expression to return the values of attributes from related resource types. A related resource type is a resource type that is either referred to explicitly in the definition of the target resource type or embedded in the target resource type.
[not.]. You can use nested notation syntax ((,...)) in a filter expression to filter by attributes from a related resource type. NOTE: Some resource types and attributes do not support filtering, which is indicated in their descriptions. You can also filter by attributes that are not requested in the select URL parameter.
Comparator Description Applicable data types Example True if the speeds array contains 1 Gbps and 10 Gbps. Contained in. cd List of any type ?server_addresses=cd. {"1.2.3.4","5.6.7.8"} True if the values in the server addresses list are all either 1.2.3.4 or 5.6.7.8. Negates the operator that follows. not All ?resource_type=not.in. (Operator,Administrator,VM Administrator) True if the value of role_id is not Operator, Administrator, or VM Administrator.
Headers Request Response body Accept: application/json Authorization: GET https://1.2.3.4/api/rest/alert?select=id,description_l10n,state&order=state [ { "id": "1bf5e114-b476-492b-a37e-7d9c1b38e7b9", "description_l10n": "Firmware version of the rights DAE PSU is no_errors. Current firmware version is 09.16s.", "state": "Active" }, { "id": "27f6caef-219a-406c-ad74-2ab801e56b19", "description_l10n": "Firmware version of the tops DAE Controller is no_errors. Current firmware version is 2.
Returning specified parameters for the appliance related to each node Headers Request Response body Accept: application/json Authorization: https://1.2.3.
Request Response body https://1.2.3.4/api/rest/appliance?select=id,name,nodes(id,name) [ ] { } "id":"A1", "name":"H0112-appliance-1", "nodes": [ { "id":"N1", "name":"H0112-appliance-1-node-A" }, { "id":"N2", "name":"H0112-appliance-1-node-B" } ] Returning only the id parameter for all nodes related to an appliance Headers Request Response body Accept: application/json Authorization: https://1.2.3.
Example Querying the protection data information for a volume Headers Request Response body Accept: application/json Authorization: https://1.2.3.
7 Creating other types of requests Creating a resource instance To create a resource instance, use the following request components: Headers Operation URI pattern Accept: application/json Content-Type: application/json Authorization: POST /api/rest/ where is the resource type of the instance you want to create. Body { } "argument1":, "argument2":, "argument3": . . .
Response body { } "id": "4" Modifying a resource instance To modify a resource instance, use the following request components: Headers Operation Accept: application/json Content-Type: application/json Authorization: PATCH URI pattern /api/rest// where: • • is the resource type of the instance you want to modify. is the unique identifier of the instance you want to modify.
Request Request body PATCH https://1.2.3.4/api/rest/volume_group/ad09bfa8-f8d8-41b5-96a9-c15c9ebdf214 { } Response body "name":"Storage resources for Marketing", "description":"Volumes for storing competitive analaysis information" Empty.
Headers Accept: application/json Authorization: If a resource type has request arguments for the DELETE operation, you must also use the following header: Content-Type: application/json Operation DELETE URI pattern /api/rest// where: • • is the resource type of the instance you want to delete. is the unique identifier of the instance you want to delete.
For operations with request arguments: Accept: application/json Content-Type: application/json Authorization: Operation POST URI pattern /api/rest/// where: • • • is the resource type of the instance for which you want to perform an action. is the unique identifier of the instance for which you want to perform an action. is the action that you want to perform.
Response body { } "id": "57cdb822-490e-4755-b8b3-99bb779b1472" Performing a class-level action Some resource types have operations that let you perform class-level actions. For example, exchanging SSL certificates with another PowerStore appliance.
Headers Accept: application/json Content-Type: application/json Authorization: Request POST /api/rest/x509_certificate/exchange Request body { } Response body "service": "Management_HTTP", "address": "10.244.53.108", "port": 8080, "username": "user1", "password": "myPassword" Empty. Working with asynchronous requests By default, all REST API requests are synchronous, which means that the client/server connection stays open until the request completes and the response is returned.
Request Request body PATCH https://1.2.3.
8 Reference content This section describes the resource types, methods, and attributes in the PowerStore Management REST API, along with other API information such as datatypes and enumerations. Reference materials are also available on the appliance in several formats: • • Swagger UI—https:///swaggerui JSON—https:///api/rest/openapi.
Resources alert Use these resource types to manage events and alerts in the system. GET /alert Description Query all alerts. Responses HTTP Code Description 200 Success 206 Partial content of alert instance objects Schema < alert_instance > array < alert_instance > array GET /alert/{id} Description Query a specific alert. Parameters Type Name id Path required Description Schema Unique identifier of the alert.
PATCH /alert/{id} Description Modify an alert. acknowledged_severity parameter, if included, will cause the request to fail when the alert’s severity is higher than the acknowledged_severity parameter value. acknowledged_severity is ignored when is_acknowledged is set to false. Parameters Type Name id Path required Description Schema Unique identifier of the specific alert.
Responses HTTP Code Description Schema < 200 appliance_instanc Success e > array < 206 Partial content of appliance instance objects appliance_instanc e > array GET /appliance/{id} Description Query a specific appliance in a cluster. Parameters Type Name id Path required Description Schema Unique identifier of the appliance.
Parameters Type Name id Path required Description Schema Unique identifier of the appliance. string body Body appliance_modify required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Argument error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • application/json Produces • application/json POST /appliance/{id}/forecast Description Forecast capacity usage for an appliance.
Responses HTTP Code Description Schema < 200 appliance_forecast Success _response > array 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json POST /appliance/{id}/time_to_full Description Returns information about when an appliance is forecast to reach 100% capacity usage. Parameters Type Name id Path required Body Description Schema Unique id of the appliance.
HTTP Code Description Schema 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json audit_event Use this resource type to query audit log information. GET /audit_event Description Query audit log entries.
Description Query bond configurations. Responses HTTP Code Description 200 Success 206 Partial content of bond instance objects Schema < bond_instance > array < bond_instance > array GET /bond/{id} Description Query a specific bond configuration. Parameters Type Name id Path required Description Schema Unique identifier of the bond configuration.
set here. For mutual mode, each initiator also has a CHAP username and password set. Changing the cluster CHAP mode disrupts all iSCSI connections, and will disable connections that are not completely and correctly configured. For example, an initiator without a valid CHAP username and password will lose connectivity to the target if mutual model is enable here. Both the settings here, and the settings on the initiators can be modified while CHAP mode is in disabled mode.
PATCH /chap_config/{id} Description Modify the CHAP configuration settings object. To enable either Single or Mutual CHAP modes, the username and password must already be set, or included in the same request as the new mode. Parameters Type Path Name Description id The id of the CHAP configuration object (always required "0").
HTTP Code Description 200 Success 206 Partial content of cluster instance objects Schema < cluster_instance > array < cluster_instance > array Produces • application/json GET /cluster/{id} Description Get details about the cluster. This does not support the following standard query functionality: property selection, and nested query embedding. Parameters Type Name id Path required Description Schema ID of the cluster.
Type Name id Path required Description Schema Unique identifier of the cluster. string body Body cluster_modify optional Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • application/json Produces • application/json POST /cluster/{id}/forecast Description Forecast capacity usage for the cluster.
HTTP Code Description Schema < 200 Success cluster_forecast_r esponse > array 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json POST /cluster/{id}/time_to_full Description Returns information about when the cluster is forecast to reach 100% capacity usage.
HTTP Code Description Schema 404 Not Found error_response 422 Operation Failed error_response Produces • application/json discovered_initiator List initiators currently connected to the cluster that are not associated with an initiator group or host. GET /discovered_initiator Description Returns connected initiators that are not associated with a host.
GET /dns Description Query DNS settings for a cluster. Responses HTTP Code Description 200 Success 206 Partial content of dns instance objects Schema < dns_instance > array < dns_instance > array GET /dns/{id} Description Query a specific DNS setting. Parameters Type Name id Path required Description Schema Unique identifier of the DNS setting.
PATCH /dns/{id} Description Modify a DNS setting. Parameters Type Name id Path required Description Schema Unique identifier of the DNS setting.
Responses HTTP Code Description Schema < 200 email_notify_desti Success nation_instance > array < 206 Partial content of email notify destination instance objects email_notify_desti nation_instance > array POST /email_notify_destination Description Add an email address to receive notifications. Parameters Type Name body Body required Description Email address to receive notifications.
Type Path Name Description id Unique identifier of the email notification required destination. Schema string Responses HTTP Code Description 200 Success 404 Not Found Schema email_notify_desti nation_instance error_response DELETE /email_notify_destination/{id} Description Delete an email notification destination. Parameters Type Path Name Description id Unique identifier of the email notification required destination.
Parameters Type Path Name Description id Unique identifier of the email notification required destination. body Body required Email address to receive notifications. Schema string email_notify_destina tion_modify Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /email_notify_destination/{id}/test Description Send a test email to an email address.
HTTP Code Description Schema 422 Operation Failed error_response eth_port This is the REST API for cluster-wide retrieval and configuration of Ethernet front-end ports. GET /eth_port Description Get Ethernet front-end port configuration for all cluster nodes.
HTTP Code Description Schema 404 Not Found error_response PATCH /eth_port/{id} Description Change the properties of the front-end port. Note that setting the port’s requested speed may not cause the port speed to change immediately. In cases where the SFP is not inserted or the port is down the requested speed will be set but the current_speed will still show the old value until the SFP is able to change speed.
Description Returns all events in the database. Responses HTTP Code Description 200 An array of events 206 Partial content of event instance objects Schema < event_instance > array < event_instance > array GET /event/{id} Description Get event by Event Id.
Responses HTTP Code Description 200 Success 206 Partial content of fc port instance objects Schema < fc_port_instance > array < fc_port_instance > array GET /fc_port/{id} Description Query a specific FC front-end port configuration. Parameters Type Name id Path required Description Schema Unique identifier of the FC front-end port.
Type Name id Path required Description Schema Unique identifier of the FC front-end port. string body Body required fc_port_modify Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request. error_response 404 Not Found error_response 422 Operation Failed error_response file_dns Use these resources to configure the Domain Name System (DNS) settings for a NAS server. One DNS settings object may be configured per NAS server.
HTTP Code Description Schema < 206 Partial content of file dns instance objects file_dns_instance > array POST /file_dns Description Create a new DNS Server configuration for a NAS Server. Only one object can be created per NAS Server.
Responses HTTP Code Description Schema 200 Success file_dns_instance 404 Not Found error_response DELETE /file_dns/{id} Description Delete DNS settings of a NAS Server. Parameters Type Name id Path required Description Schema Unique identifier of the DNS object. string Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_dns/{id} Description Modify the DNS settings of a NAS Server.
Type Name Description body Body required Schema file_dns_modify Responses HTTP Code Description Schema 204 Success. No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response file_ftp Use these resources to configure one File Transfer Protocol (FTP) server per NAS server. One FTP server can be configured per NAS server to have both secure and unsecure services running.
HTTP Code Description 206 Partial content of file ftp instance objects Schema < file_ftp_instance > array POST /file_ftp Description Create an FTP/SFTP server. Parameters Type Name body Body required Schema file_ftp_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_ftp/{id} Description Query a specific FTP/SFTP server for its settings.
HTTP Code Description Schema 200 Success file_ftp_instance 404 Not Found error_response DELETE /file_ftp/{id} Description Delete an FTP/SFTP Server. Parameters Type Name id Path required Description Schema Unique identifier of the FTP/SFTP Server object. string Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_ftp/{id} Description Modify an FTP/SFTP server settings.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response file_interface Information about File network interfaces in the storage system. These interfaces control access to Windows (CIFS) and UNIX/Linux (NFS) file storage. GET /file_interface Description Query file interfaces.
Type Name body Body required Schema file_interface_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_interface/{id} Parameters Type Name id Path required Description Schema Unique identifier of the file interface.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_interface/{id} Description Modify the settings of a file interface. Parameters Type Name id Path required Body Description Schema Unique identifier of the file interface.
defined by an interface, destination IP address range and an IP address of a corresponding gateway. Note: IP routes connect an interface (IP address) to the larger network through gateways. Without routes and gateway specified, the interface is no longer accessible outside of its immediate subnet. As a result, network shares and exports associated with the interface are no longer available to clients outside their immediate subnet. GET /file_interface_route Description Query file interface routes.
Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_interface_route/{id} Description Query a specific file interface route for details. Parameters Type Path Name Description id Unique identifier of the file interface route required object.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_interface_route/{id} Description Modify file interface route settings. Parameters Type Path Body Name Description id Unique identifier of the file interface route required object.
framework and Kerberos authentication protocol to verify users and services. You can configure a secure NFS environment for a multiprotocol NAS Server or one that supports Unix-only shares. In this environment, user access to NFS file systems is granted based on Kerberos principal names. GET /file_kerberos Description Query of the Kerberos service settings of NAS Servers. Responses HTTP Code Description Schema < 200 Success.
GET /file_kerberos/{id} Description Query a specific Kerberos service settings of a NAS Server. Parameters Type Name id Path required Description Schema Kerberos service object. string Responses HTTP Code Description 200 Success 404 Not Found Schema file_kerberos_inst ance error_response DELETE /file_kerberos/{id} Description Delete Kerberos configuration of a NAS Server. Parameters Type Name id Path required Description Schema Unique identifier of the Kerberos service object.
PATCH /file_kerberos/{id} Description Modify the Kerberos service settings of a NAS Server. Parameters Type Name id Path required Body Description Schema Unique identifier of the Kerberos service object. string body file_kerberos_modif required y Responses HTTP Code Description Schema 204 Success.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • multipart/form-data GET /file_kerberos/{id}/download_keytab Description Download previously uploaded keytab file for secure NFS service. Parameters Type Name id Path required Description Schema Unique identifier of the Kerberos service object.
file_ldap Use these resources to manage the Lightweight Directory Access Protocol (LDAP) settings for the NAS Server. You can configure one LDAP settings object per NAS Server. LDAP is an application protocol for querying and modifying directory services running on TCP/IP networks. LDAP provides central management for network authentication and authorization operations by helping to centralize user and group management across the network.
HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_ldap/{id} Description Query a specific NAS Server’s LDAP settings object. Parameters Type Name id Path required Description Schema Unique identifier of the LDAP settings object.
HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_ldap/{id} Description Modify a NAS Server’s LDAP settings object. Parameters Type Name id Path required Description Schema Unique identifier of the LDAP settings object id.
Type Name Description FormDat body a Schema file required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • multipart/form-data GET /file_ldap/{id}/download_config Parameters Type Name id Path required Description Schema Unique identifier of the LDAP settings object.
POST /file_ldap/{id}/upload_certificate Parameters Type Name id Path required Description Schema Unique identifier of the LDAP settings object.
HTTP Code Description Schema 422 Operation Failed error_response Produces • document/text file_ndmp The Network Data Management Protocol (NDMP) provides a standard for backing up file servers on a network. NDMP allows centralized applications to back up file servers that run on various platforms and platform versions. NDMP reduces network congestion by isolating control path traffic from data path traffic, which permits centrally managed and monitored local backup operations.
Parameters Type Name body Body required Schema file_ndmp_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_ndmp/{id} Description Query an NDMP service configuration instance. Parameters Type Name id Path required Description Schema Unique identifier of the NDMP service object.
Parameters Type Name id Path required Description Schema Unique identifier of the NDMP service object. string Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_ndmp/{id} Description Modify an NDMP service configuration instance. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the NDMP service object.
file_nis Use these resources to manage the Network Information Service (NIS) settings object for a NAS Server. One NIS settings object may be configured per NAS server. NIS consists of a directory service protocol for maintaining and distributing system configuration information, such as user and group information, hostnames, and such. The port for NIS Service is 111. GET /file_nis Description Query the NIS settings of NAS Servers. Responses HTTP Code Description 200 Success.
HTTP Code Description Schema 422 Operation Failed error_response GET /file_nis/{id} Description Query a specific NIS settings object of a NAS Server. Parameters Type Name id Path required Description Schema Unique identifier of the NIS object. string Responses HTTP Code Description Schema 200 Success file_nis_instance 404 Not Found error_response DELETE /file_nis/{id} Description Delete NIS settings of a NAS Server.
HTTP Code Description Schema 404 Not Found error_response 422 Operation Failed error_response PATCH /file_nis/{id} Description Modify the NIS settings of a NAS Server. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the NIS object. string file_nis_modify Responses HTTP Code Description Schema 204 Success.
Responses HTTP Code Description Schema < 200 file_system_instan Success ce > array < 206 Partial content of file system instance objects file_system_instan ce > array POST /file_system Description Create a file system. Parameters Type Name body Body required Schema file_system_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_system/{id} Description Query a specific file system.
Type Name id Path required Description Schema File system id. string Responses HTTP Code Description 200 Success 404 Not Found Schema file_system_instan ce error_response DELETE /file_system/{id} Description Delete a file system. Parameters Type Name id Path required Description Schema File system id.
Parameters Type Name id Path required Description Schema File system id. string body Body file_system_modify required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /file_system/{id}/clone Description Create a clone of a file system. Parameters Type Name id Path required body Body required Description Schema File system id.
HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /file_system/{id}/snapshot Description Create a snapshot of a file system. Parameters Type Name id Path required Body Description Schema File system id.
Description Refresh a snapshot of a file system. The content of the snapshot is replaced with the current content of the parent file system. Parameters Type Name id Path required Description Schema File system snapshot id. string Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response POST /file_system/{id}/restore Description Restore from a snapshot of a file system.
HTTP Code Description 200 Success (with backup snapshot) 204 Success (without backup snapshot) No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Schema file_system_restor e_response POST /file_system/{id}/refresh_quota Description Refresh the actual content of tree and user quotas objects. Parameters Type Name id Path required Description Schema File system id.
GET /file_tree_quota Description List tree quota instances. Responses HTTP Code Description Schema < 200 Success file_tree_quota_in stance > array < 206 Partial content of file tree quota instance objects file_tree_quota_in stance > array POST /file_tree_quota Description Create a tree quota instance.
Parameters Type Name id Path required Description Schema Unique identifier of the tree quota. string Responses HTTP Code Description 200 Success 404 Not Found Schema file_tree_quota_in stance error_response DELETE /file_tree_quota/{id} Description Delete a tree quota instance. Parameters Type Name id Path required Description Schema Unique identifier of the tree quota.
Parameters Type Name id Path required Body Description Schema Unique identifier of the tree quota. string body file_tree_quota_mod required ify Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /file_tree_quota/{id}/refresh Description Refresh the cache with the actual value of the tree quota.
HTTP Code Description Schema 422 Operation Failed error_response file_user_quota User quota settings in the storage system. A user quota instance represents a quota limit applied to a user within a quota tree or a filesystem. GET /file_user_quota Description List user quota instances.
HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /file_user_quota/{id} Description Query a user quota instance. Parameters Type Name id Path required Description Schema Unique identifier of the file user quota. string Responses HTTP Code Description 200 Success 404 Not Found Schema file_user_quota_in stance error_response PATCH /file_user_quota/{id} Description Modify a user quota instance.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /file_user_quota/{id}/refresh Description Refresh the cache with the actual value of the user quota. Parameters Type Name id Path required Description Schema Unique identifier of the file user quota.
blocked. If the file does not contain a virus, it is written to the file system. If the file is infected, corrective action (fixed, removed or placed in quarantine) is taken as defined by the anti-virus server. You can optionally set up the service to scan the file on read access based on last access of the file compared to last update of the third-party anti-virus date. GET /file_virus_checker Description Query all virus checker settings of the NAS Servers.
HTTP Code Description Schema 400 Invalid Request error_response 422 Operation Failed error_response GET /file_virus_checker/{id} Description Query a specific virus checker setting of a NAS Server. Parameters Type Name id Path required Description Schema Unique identifier of the virus checker instance.
HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /file_virus_checker/{id} Description Modify the virus checker settings of a NAS Server. Parameters Type Name id Path required Body Description Schema Unique identifier of the virus checker instance.
Type Name id Path required FormDat body a optional Description Schema Unique identifier of the virus checker instance. string Upload virus checker configuration file.
HTTP Code Description Schema 422 Operation Failed error_response Produces • document/text hardware This provides the hardware component inventory of the system. GET /hardware Description List hardware components. Responses HTTP Code Description Schema < 200 Success hardware_instanc e > array < 206 Partial content of hardware instance objects hardware_instanc e > array Produces • application/json GET /hardware/{id} Description Get a specific hardware component instance.
Responses HTTP Code Description 200 Success 404 Not Found Schema hardware_instanc e error_response Produces • application/json PATCH /hardware/{id} Description Modify a hardware instance. Parameters Type Name id Path required body Body required Description Schema The hardware component to modify.
Produces • application/json POST /hardware/{id}/drive_repurpose Description A drive that has been used in a different appliance will be locked for use only in that appliance. This operation will allow a locked drive to be used in the current appliance. All data on the drive will become unrecoverable. It will fail if the drive is not locked to a different appliance. Parameters Type Name id Path required body Body required Description Schema Identifier of the drive to repurpose.
Responses HTTP Code Description 200 Success 206 Partial content of host instance objects Schema < host_instance > array < host_instance > array Produces • application/json POST /host Description Add a host.
GET /host/{id} Description Get details about a specific host by id. Parameters Type Name id Path required Description Schema Unique id of the host. string Responses HTTP Code Description Schema 200 Success host_instance 404 Not Found error_response Produces • application/json DELETE /host/{id} Description Delete a host. Delete fails if host is attached to a volume or consistency group.
HTTP Code Description Schema 400 Invalid Input error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json PATCH /host/{id} Description Operation that can be performed are modify name, modify description, remove initiator(s) from host, add initiator(s) to host, update existing initiator(s) with chap username/password. This will only support one of add, remove and update initiator operations in a single request.
POST /host/{id}/attach Description Attach host to volume. Parameters Type Name id Path required Description Schema Unique id of the host. string body Body host_attach required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Input error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json POST /host/{id}/detach Description Detach host from volume.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Input error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json host_group Manage host groups. A host group is a mechanism to provision hosts and volumes to be consistent across the Cyclone cluster. Operations that can be performed include, creating or deleting a host group, modifying host group(i.e. adding or removing hosts from a host group).
POST /host_group Description Create a host group. Parameters Type Name body Body required Schema host_group_create Responses HTTP Code Description Schema 201 Created create_response 400 Operation Failed error_response 422 Operation Failed error_response Consumes • application/json Produces • application/json GET /host_group/{id} Description Get details about a specific host group. Parameters Type Path Name id required Description Schema Unique id of the host group.
HTTP Code Description 200 Success 404 Not Found Schema host_group_instan ce error_response Produces • application/json DELETE /host_group/{id} Description Delete a host group. Delete fails if host group is attached to a volume. Parameters Type Name id Path required Description Schema Unique id of the host group.
Parameters Type Name id Path required Description Schema Unique id of the host group. string body Body host_group_modify required Responses HTTP Code Description Schema 204 Success No Content 400 Operation Failed error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json POST /host_group/{id}/attach Description Attach host group to volume.
HTTP Code Description Schema 204 Success No Content 400 Invalid Input error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json POST /host_group/{id}/detach Description Detach host group from volume. Parameters Type Name id Path required body Body required Description Schema Unique id of the host group.
host_virtual_volume_mapping Virtual volume mapping details. GET /host_virtual_volume_mapping Description Query associations between a virtual volume and the host(s) it is attached to. Responses HTTP Code Description Schema < 200 host_virtual_volu Success me_mapping_inst ance > array < 206 Partial content of host virtual volume mapping instance objects host_virtual_volu me_mapping_inst ance > array GET /host_virtual_volume_mapping/{id} Description Query a specific virtual volume mapping.
HTTP Code Description Schema 404 Not Found error_response host_volume_mapping Storage cluster REST API definition. GET /host_volume_mapping Description Query associations between a volume and the host or host group it is attached to.
HTTP Code Description 200 Success 404 Not Found Schema host_volume_map ping_instance error_response import_host_initiator Use these resource types to manage import host initiators. Once import host is configured, host initiators can be queried and corresponding mapped volumes can be imported. GET /import_host_initiator Description Query import host initiators.
Responses HTTP Code Description 200 Success 404 Not Found Schema import_host_initia tor_instance error_response import_host_system Use these resource types to manage import host systems. Import host enables communication with multipathing software on the host system to perform import operations. While configuring the import_host_system if the host is not present a new Host will be created. If Host is already present, the same Host will be updated with the import_host_system details.
created. If Host is already present, the same Host will be updated with the import_host_system details. Parameters Type Name request Body required Description Request parameters. Schema import_host_system_ create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /import_host_system/{id} Description Query a specific import host system instance.
Description Delete an import host system. You cannot delete an import host system if there are import sessions active in the system referencing the import host system instance.
HTTP Code Description Schema 422 Operation Failed error_response import_host_volume Use these resource types to manage import host volumes. Host volumes are source storage volumes that are mapped to the host systems for application access. Once import host is configured, host volumes can be queried and then corresponding volumes can be imported. GET /import_host_volume Description Query import host volumes.
Responses HTTP Code Description 200 Success 404 Not Found Schema import_host_volu me_instance error_response import_psgroup Use these resource types to discover the Peer Storage Group (PS Group) volumes that can be imported to PowerStore. GET /import_psgroup Description Query PS Group storage arrays.
Responses HTTP Code Description 200 Success 404 Not Found Schema import_psgroup_i nstance error_response POST /import_psgroup/{id}/discover Description Discover the importable volumes and snapshot schedules in the PS Group. Parameters Type Name id Path required Description Schema Unique identifier of the PS Group.
Responses HTTP Code Description Schema < 200 import_psgroup_v Success olume_instance > array < 206 Partial content of import psgroup volume instance objects import_psgroup_v olume_instance > array GET /import_psgroup_volume/{id} Description Query a specific PS Group volume. Parameters Type Name id Path required Description Schema Unique identifier of the PS Group volume.
Type Name id Path required Description Schema Unique identifier of the PS Group volume.
HTTP Code Description Schema < 206 Partial content of import session instance objects import_session_in stance > array POST /import_session Description Create a new import session. The source storage system and hosts that access the volumes or consistency groups must be added prior to creating an import session. The volumes or consistency groups must be in a migration-ready state.
Responses HTTP Code Description 200 Success 404 Not Found Schema import_session_in stance error_response DELETE /import_session/{id} Description Delete an import session that is in a Completed, Failed, or Cancelled state. Delete removes the historical record of the import. To stop active import sessions, use the Cancel operation. You can delete the import session after cancelling it.
Type Name Body Description Schema body import_session_mod required ify Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /import_session/{id}/cutover Description Commit an import session that is in a Ready_For_Cutover state. When the import session is created with the automatic_cutover attribute set to false, you must use the Cutover operation to complete the import.
HTTP Code Description Schema 422 Operation Failed error_response POST /import_session/{id}/cancel Description Cancel an active import session. Cancel is allowed when the import is in a Scheduled, Queued, Copy_In_Progress, or Ready_For_Cutover state. After a successful cancellation, the host is mapped to original source volume, all paths are cleaned up, and the import state is Cancelled. The import can be attempted again in the future.
You can resume or cancel the paused import. Parameters Type Name id Path required Description Schema Unique identifier of the import session string Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response POST /import_session/{id}/resume Description Resumes the paused import session. The background data copy continues from where it was stopped.
HTTP Code Description Schema 422 Operation Failed error_response POST /import_session/{id}/cleanup Description Clean up an import session that is in Cleanup_Required state and requires user intervention to revert the source volume to its pre-import state as part of the recovery procedure to restore host IO operations. Parameters Type Name id Path required Description Schema Unique identifier of the import session.
HTTP Code Description Schema < 200 import_storage_ce Success nter_instance > array < 206 Partial content of import storage center instance objects import_storage_ce nter_instance > array GET /import_storage_center/{id} Description Query a specific SC array. Parameters Type Name id Path required Description Schema Unique identifier of the SC array.
Type Name id Path required Description Schema Unique identifier of the SC array. string Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response import_storage_center_consistency_group Use these resource types to discover the Storage Center (SC) volumes and consistency groups that can be imported to PowerStore.
GET /import_storage_center_consistency_group/{id} Description Query a specific SC consistency group. Parameters Type Name id Path required Description Schema Unique identifier of the SC consistency group. string Responses HTTP Code Description Schema import_storage_ce 200 nter_consistency_ Success group_instance 404 Not Found error_response POST /import_storage_center_consistency_group/{id}/import_snapshot_profiles Description Return the snapshot profiles of an SC consistency group.
HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed. error_response import_storage_center_volume Use these resource types to discover the Storage Center (SC) volumes that can be imported to PowerStore. GET /import_storage_center_volume Description Query SC volumes.
Type Name id Path required Description Schema Unique identifier of the SC volume. string Responses HTTP Code Description Schema import_storage_ce 200 nter_volume_insta Success nce 404 Not Found error_response POST /import_storage_center_volume/{id}/import_snapshot_profiles Description Return the snapshot profiles of an SC volume. Parameters Type Name id Path required Description Schema Unique identifier of the SC volume.
import_unity Use this resource type to discover the Unity system that is a source storage system for import GET /import_unity Description Query Unity storage systems. Responses HTTP Code Description Schema < 200 Success import_unity_inst ance > array < 206 Partial content of import unity instance objects import_unity_inst ance > array GET /import_unity/{id} Description Query a specific Unity storage system.
POST /import_unity/{id}/discover Description Discover the importable volumes and consistency groups in the Unity storage system. Parameters Type Name id Path required Description Schema Unique identifier of the Unity storage system.
HTTP Code Description Schema < 206 Partial content of import unity consistency group instance objects import_unity_cons istency_group_inst ance > array GET /import_unity_consistency_group/{id} Description Query a specific Unity consistency group. Parameters Type Name id Path required Description Schema Unique identifier of the Unity consistency group.
HTTP Code Description Schema import_unity_cons 200 Success istency_group_im port_snapshot_sch edules_response 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response import_unity_volume Use this resource type to discover the Unity volumes that can be imported to PowerStore. GET /import_unity_volume Description Query Unity volumes.
Parameters Type Name id Path required Description Schema Unique identifier of the Unity volume. string Responses HTTP Code Description 200 Success 404 Not Found Schema import_unity_volu me_instance error_response POST /import_unity_volume/{id}/import_snapshot_schedules Description Return the snapshot schedules associated with the specified Unity volume. Parameters Type Name id Path required Description Schema Unique identifier of the Unity volume.
import_vnx_array Use these resource types to discover the VNX storage system that can be imported to PowerStore. GET /import_vnx_array Description Query VNX storage systems. Responses HTTP Code Description Schema < 200 Success import_vnx_array _instance > array < 206 Partial content of import vnx array instance objects import_vnx_array _instance > array GET /import_vnx_array/{id} Description Query a specific VNX storage system.
POST /import_vnx_array/{id}/discover Description Discover the importable volumes and consistency groups in a VNX storage system. Parameters Type Name id Path required Description Schema Unique identifier of the VNX storage system.
HTTP Code Description Schema < 206 Partial content of import vnx consistency group instance objects import_vnx_consis tency_group_insta nce > array GET /import_vnx_consistency_group/{id} Description Query a specific VNX consistency group. Parameters Type Name id Path required Description Schema Unique identifier of a VNX consistency group.
HTTP Code Description Schema < 200 import_vnx_volu Success me_instance > array < 206 Partial content of import vnx volume instance objects import_vnx_volu me_instance > array GET /import_vnx_volume/{id} Description Query a specific VNX volume. Parameters Type Name id Path required Description Schema Unique identifier of the VNX volume.
Responses HTTP Code Description Schema < 200 ip_pool_address_i Success nstance > array < 206 Partial content of ip pool address instance objects ip_pool_address_i nstance > array GET /ip_pool_address/{id} Description Query a specific IP address. Parameters Type Name id Path required Description Schema Unique identifier of a configured IP address.
GET /ip_port Description Query IP port configurations. Responses HTTP Code Description 200 Success 206 Partial content of ip port instance objects Schema < ip_port_instance > array < ip_port_instance > array GET /ip_port/{id} Description Query a specific IP port configuration. Parameters Type Name id Path required Description Schema Unique identifier of the IP port.
PATCH /ip_port/{id} Description Modify IP port parameters. Parameters Type Name id Path required Description Schema Unique identifier of the IP port. string body Body optional ip_port_modify Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • application/json Produces • application/json job Use this resource type for tracking an operation’s progress and status.
Responses HTTP Code Description 200 An array of jobs 206 Partial content of job instance objects Schema < job_instance > array < job_instance > array GET /job/{id} Description Query a specific job. Parameters Type Name id Path required Description Schema Unique id of the job. string Responses HTTP Code Description Schema 200 A single job. job_instance 404 Not Found error_response keystore_archive Use this resource to generate and download an encryption keystore archive file.
Responses HTTP Code Description Schema keystore_archive_ 200 regenerate_respon Success se 204 Success No Content 400 Invalid request error_response 422 Operation Failed error_response Produces • application/json GET /keystore_archive/{filename} Description Download a keystore backup archive file that was previously generated by a successful /api/rest/keystore_archive/regenerate POST command.
Produces • application/zip license Use this resource type to view and manage the software license for the cluster. Licenses are normally automatically retrieved when the system is configured. If the system cannot reach the DellEMC Software Licensing Central, it will retry daily during the 30-day trial period. After the trial period, the system will continue to operate but no new provisioning operations will be allowed.
Parameters Type Path Name Description id Unique identifier of the license information required instance. Schema string Responses HTTP Code Description Schema 200 Success license_instance 404 Not Found error_response POST /license/upload Description Upload a software license to install the license on the cluster. Parameters Type Name Description FormDat license_file The file to upload containing the software a license to install the license on the cluster.
Description Retrieve the license directly from the DellEMC Software Licensing Central. This runs automatically when the cluster is configured, and if it fails, once per day during the trial period. This allows a manual attempt, normally after attempting to correct the network connectivity issue preventing the automatic retrieval.
locked. Parameters Type Name body Body required Schema local_user_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /local_user/{id} Description Query a specific local user account instance using an unique identifier. Parameters Type Name id Path required Description Schema Unique identifier of the local user account.
Description Delete a local user account instance using the unique identifier. You cannot delete the default "admin" account or the account you are currently logged into. Any local user account with Administrator or Security Administrator role can delete any other local user account except the default "admin" account. Parameters Type Path Name Description id Unique identifier of the local user account to be required deleted.
HTTP Code Description Schema 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response login_session Use these resource types to manage sessions, roles, and system security configurations. GET /login_session Description Obtain the login session for the current user.
Responses HTTP Code Description Schema 201 Success create_response 204 Success No Content 400 Invalid request error_response 422 Operation Failed error_response Produces • application/json maintenance_window Use this resource type to manage the maintenance window configuration for each appliance. The maintenance window allows you to set a time period during which alerts do not generate any notifications.
GET /maintenance_window/{id} Description Query one appliance maintenance window configuration. Parameters Type Path Name Description id Unique identifier of the maintenance window required configuration. Schema string Responses HTTP Code Description 200 Success 404 Not Found Schema maintenance_win dow_instance error_response PATCH /maintenance_window/{id} Description Configure maintenance window.
HTTP Code Description Schema 404 Not Found error_response 422 Operation Failed error_response metrics REST APIs Use these resource types to query historical metric data. POST /metrics/generate Description Retrieves metrics for specified type.
create_migration_sessions action, performing any necessary rescans on attached hosts, and then using start_migration_sessions. GET /migration_recommendation Description Get migration recommendations.
GET /migration_recommendation/{id} Description Get a single migration recommendation. Parameters Type Name id Path required Description Schema Unique ID of the migration recommendation. string Responses HTTP Code Description Schema migration_recom 200 mendation_instan Success ce 404 Not found error_response DELETE /migration_recommendation/{id} Description Delete a migration recommendation.
POST /migration_recommendation/{id}/create_migration_sessions Description Create the migration sessions to implement a migration recommendation. If the response contains a list of hosts to rescan, those hosts must be rescanned before starting the sessions or the host(s) may lose access to the data when the migration completes. Parameters Type Name id Path required Description Schema Unique ID of the migration recommendation.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Invalid Request error_response migration_session Manage migration sessions. GET /migration_session Description Query migration sessions. Responses HTTP Code Description Schema < 200 Success migration_session _instance > array POST /migration_session Description Create a new migration session.
Type Name body Body required Description Parameters to create a migration session. Schema migration_session_c reate Responses HTTP Code Description 201 Created 400 Invalid Request error_response 422 Operation Failed error_response Schema migration_session _create_response Produces • application/json GET /migration_session/{id} Description Query a specific migration session. Parameters Type Name id Path required Description Schema Unique identifier of the migration session.
DELETE /migration_session/{id} Description Delete a migration session. With the force option, a migration session can be deleted regardless of its state. All background activity is canceled before deleting the session. Parameters Type Name id Path required body Body optional Description Schema Unique identifier of the migration session. string Parameters for a deletion.
HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /migration_session/{id}/resume Description Resume a paused migration session. You cannot resume a migration session in the failed state. Parameters Type Name id Path required Description Schema Unique identifier of the migration session.
Parameters Type Name id Path required Body Description Schema Unique identifier of the migration session. string body Parameters required session.
HTTP Code Description Schema 422 Operation Failed error_response nas_server Use these resource types to manage NAS servers. NAS servers are software components used to transfer data and provide the connection ports for hosts to access file-based storage resources. NAS servers are independent from each other. GET /nas_server Description Query all NAS servers.
HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /nas_server/{id} Description Query a specific NAS server. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server. string Responses HTTP Code Description 200 Success 404 Not Found Schema nas_server_instan ce error_response DELETE /nas_server/{id} Description Delete a NAS server.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /nas_server/{id} Description Modify the settings of a NAS server. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
Parameters Type Name id Path required Description Schema Unique identifier of the NAS server. string body Body nas_server_ping required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response POST /nas_server/{id}/upload/passwd Description Upload NAS server passwd file.
HTTP Code Description Schema 404 Not Found error_response 422 Operation Failed error_response Consumes • multipart/form-data GET /nas_server/{id}/download/passwd Description Download a NAS server passwd file containing template or the actual (if already uploaded) passwd details. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload NAS server host file. file Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • multipart/form-data GET /nas_server/{id}/download/hosts Description Download an NAS server host file containing template/actual(if already uploaded) host details.
HTTP Code Description Schema 422 Operation Failed error_response Produces • document/text POST /nas_server/{id}/upload/group Description Upload NAS server group file. Parameters Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload NAS server group file.
Parameters Type Name id Path required Description Schema Unique identifier of the NAS server. string Responses HTTP Code Description Schema 200 Success No Content 404 Not Found error_response 422 Operation Failed error_response Produces • document/text POST /nas_server/{id}/upload/netgroup Description Upload the NAS server netgroup file. Parameters Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server.
HTTP Code Description Schema 422 Operation Failed error_response Consumes • multipart/form-data GET /nas_server/{id}/download/netgroup Description Download an NAS server netgroup file containing the template or the actual (if already uploaded) netgroup details. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload the NAS server nsswitch file.
HTTP Code Description Schema 422 Operation Failed error_response Produces • document/text POST /nas_server/{id}/upload/homedir Description Upload the NAS server homedir file. Parameters Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload the NAS server homedir file.
Parameters Type Name id Path required Description Schema Unique identifier of the NAS server. string Responses HTTP Code Description Schema 200 Success No Content 404 Not Found error_response 422 Operation Failed error_response Produces • document/text POST /nas_server/{id}/upload/ntxmap Parameters Type Name id Path required FormDat body a optional Description Schema Unique identifier of the NAS server. string Upload the NAS server ntxmap file.
Consumes • multipart/form-data GET /nas_server/{id}/download/ntxmap Description Download an NAS server ntxmap file containing the template or the actual (if already uploaded) ntxmap configuration settings. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response GET /nas_server/{id}/download/user_mapping_report Description Download the report generated by the update_user_mappings action. Parameters Type Name id Path required Description Schema Unique identifier of the NAS server.
GET /network Description Query the IP network configurations of the cluster. Responses HTTP Code Description Schema < 200 Success network_instance > array < 206 Partial content of network instance objects network_instance > array GET /network/{id} Description Query a specific IP network configuration. Parameters Type Name id Path required Description Schema Unique identifier of the IP network.
PATCH /network/{id} Description Modify IP network parameters, such as gateways, netmasks, VLAN identifiers, and IP addresses. Parameters Type Name id Path required Description Schema Unique identifier of the IP network.
Type Name Description body Body Schema network_replace required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • application/json Produces • application/json POST /network/{id}/scale Description Add IP ports for use by the storage network, or remove IP ports so they can no longer be used. At least one IP port must be configured for use by the storage network.
HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Consumes • application/json Produces • application/json nfs_export NFS Exports use the NFS protocol to provide an access point for configured Linux/Unix hosts or IP subnets to access file_systems or file_snapshots. GET /nfs_export Description List NFS Exports.
Parameters Type Name body Body required Schema nfs_export_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /nfs_export/{id} Description Get NFS Export properties. Parameters Type Name id Path required Description Schema NFS Export object id.
Parameters Type Name id Path required Description Schema NFS Export object id. string Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /nfs_export/{id} Description Modify NFS Export Properties. Parameters Type Name id Path required body Body required Description Schema NFS Export object id.
nfs_server Use these resource types to manage NFS servers. One NFS server may be configured per NAS server. At least one NFS share must be created from an NFS server before an NFS client can connect to the storage resources. NFS servers can support the NFSv3 and NFSv4 protocols. The default protocol is NFSv3. It is enabled when the NFS server is created and remains active until the NFS server is deleted. GET /nfs_server Description Query all NFS Servers.
HTTP Code Description Schema 400 Invalid Request error_response 422 Operation Failed error_response GET /nfs_server/{id} Description Query settings of an NFS server. Parameters Type Name id Path required Description Schema Unique identifier of the NFS server. string Responses HTTP Code Description 200 Success 404 Not Found Schema nfs_server_instanc e error_response DELETE /nfs_server/{id} Description Delete an NFS server.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /nfs_server/{id} Description Modify NFS server settings. Parameters Type Name id Path required Description Schema Unique identifier of the NFS server.
Parameters Type Name id Path required Description Schema Unique identifier of the NFS server. string body Body nfs_server_join required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response POST /nfs_server/{id}/unjoin Description Unjoin the secure NFS server from the NAS server’s Active Directory domain.
HTTP Code Description Schema 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response node Use this resource type to retrieve information about nodes in a cluster. GET /node Description Query the nodes in a cluster. Responses HTTP Code Description 200 Success 206 Partial content of node instance objects Schema < node_instance > array < node_instance > array GET /node/{id} Description Query a specific node in a cluster.
HTTP Code Description Schema 200 Success node_instance 404 Not found error_response Consumes • application/json Produces • application/json ntp Manage DNS and NTP settings for the cluster. GET /ntp Description Query NTP settings for a cluster. Responses HTTP Code Description 200 Success 206 Partial content of ntp instance objects Schema < ntp_instance > array < ntp_instance > array GET /ntp/{id} Description Query a specific NTP setting.
Responses HTTP Code Description Schema 200 Success ntp_instance 404 Not Found error_response PATCH /ntp/{id} Description Modify NTP settings. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the NTP setting.
performance_rule Information about performance rules that can be use in performance policies applied to volumes and volume groups. GET /performance_rule Description Get performance rules. Responses HTTP Code Description Schema < 200 performance_rule OK _instance > array < 206 Partial content of performance rule instance objects performance_rule _instance > array Produces • application/json GET /performance_rule/{id} Description Get a performance rule by id.
HTTP Code Description Schema 404 The performance_rule does not exist. error_response Produces • application/json physical_switch Manage physical switches settings for the cluster. GET /physical_switch Description Query physical switches settings for a cluster.
HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /physical_switch/{id} Description Query a specific physical switch settings. Parameters Type Name id Path required Description Schema Unique identifier of the physical switch settings.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /physical_switch/{id} Description Modify a physical switch settings. Parameters Type Name id Path required Body Description Schema Unique identifier of the physical switch settings.
GET /policy Description Query protection and performance policies. The following REST query is an example of how to retrieve protection policies along with their rules and associated resources: https://{{cluster_ip}}/api/rest/policy? select=name,id,type,replication_rules(id,name,rpo,remote_system(id,name,management_address)), snapshot_rules(id,name,interval,time_of_day,days_of_week),volume(id,name),volume_group(id,na me)&type=eq.
Responses HTTP Code Description Schema 201 Success create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /policy/{id} Description Query a specific policy. Parameters Type Name id Path required Description Schema Unique identifier of the policy. string Responses HTTP Code Description Schema 200 Success policy_instance 404 Not Found error_response DELETE /policy/{id} Description Delete a protection policy.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /policy/{id} Description Modify a protection policy. Parameters Type Name id Path required body Body optional Description Schema Unique identifier of the policy to be modified.
The PowerStore local system can establish a remote system relationship with different types of remote storage systems for replication remote protection and import use-cases. Refer to the RemoteSystemTypeEnum specification for a list of system types supported. NOTE Before creating a remote system relationship with PowerStore remote systems, first establish a Certificate Based Trust between the local and remote PowerStore systems using the verify and exchange operations on the x509_certificate resource type.
• Name • Description • Remote administrator credentials • iSCSI address - IPv4 address • CHAP mode for discovery or session • CHAP secrets details After the remote system relationship is created, the local system can communicate with the remote system, and open data connections for data transfer. Parameters Type Name body Body required Description Parameters to create a remote system.
HTTP Code Description 200 Success 404 Not Found Schema remote_system_in stance error_response DELETE /remote_system/{id} Description Delete a remote system. Deleting the remote system deletes the management and data connections established with the remote system. You cannot delete a remote system if there are active import sessions, or if there are remote protection policies active in the system referencing the remote system instance.
Description Modify a remote system instance. The list of valid parameters depends on the type of remote system. For PowerStore remote system relationships: • Description • Management address - An IPv4 or IPv6 address. FQDN is not supported. For non-PowerStore remote system relationships: • Name • Description • Management address - An IPv4 address. FQDN is not supported. • Remote administrator credentials • iSCSI address - An IPv4 address.
Description Verify and update the remote system instance. Detects changes in the local and remote systems and reestablishes data connections, also taking the Challenge Handshake Authentication Protocol (CHAP) settings into account. Parameters Type Name id Path required body Body optional Description Schema Unique identifier of the remote system. string Parameters to verify a remote system.
HTTP Code Description Schema < 200 Success replication_rule_i nstance > array < 206 Partial content of replication rule instance objects replication_rule_i nstance > array POST /replication_rule Description Create a new replication rule.
Responses HTTP Code Description 200 Success 404 Not Found Schema replication_rule_i nstance error_response DELETE /replication_rule/{id} Description Delete a replication rule. Deleting a rule is not permitted, if the rule is associated with a protection policy that is currently applied to a storage resource. Parameters Type Name id Path required Description Schema Unique identifier of the replication rule.
either of the following: Remove the protection policy association from the relevant storage resources, modify the replication rule, and then associate the storage resources with the relevant protection policies. Remove the replication rule from the protection policies that use it, modify the replication rule, and then associate it back with the relevant protection policies. Parameters Type Name id Path required Body Description Schema Unique identifier of the replication rule.
Replication sessions also provides pause and resume capabilities, to allow for production or disaster recovery-side maintenance requirements. Destination storage resources are in replication destination mode, which disables any write access to the destination resource. Any operations such as resizing the volume, restoring the snapshot, or changing membership for a volume group on the resource are not allowed.
HTTP Code Description 200 Success 404 Not Found Schema replication_sessio n_instance error_response POST /replication_session/{id}/sync Description Synchronize the destination resource with changes on source resource from the previous synchronization cycle. Synchronization happens either automatically according to a set schedule, or manually. User and scheduler-created snapshots are synchronized from the source system to the destination system while maintaining block sharing efficiency.
Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /replication_session/{id}/pause Description Pause a replication session instance. You can pause a replication session when you need to modify the source or destination system. For example, you can pause the replication session to take the source or destination system down for maintenance.
Failover Use to get production access from the disaster recovery site • Delete the replication session by removing the protection policy on the storage resource The following system operations may also pause, and subsequently resume, a replication session: • Non-disruptive upgrade • Intra-cluster migration Leaving replication session in a paused state results in change accumulations on the source system, and consume more storage on the source system.
also pause, and subsequently resume, a replication session. • Paused_for_NDU • Paused_for_Migration Parameters Type Name id Path required Description Schema Unique identifier of the replication session. string Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response POST /replication_session/{id}/failover Description Fail over a replication session instance.
parameter, which activates the session in the reverse direction. Unplanned failures are events such as source system failure or an event on the source system that leads to downtime for production access. Unplanned failovers are issued from the destination system, and are indicated by setting the is_planned parameter to false. Unplanned failovers provide production access to the original destination resource from a preview synchronized point-in-time snapshot referred to as replication common-base.
Parameters Type Name id Path required Description Schema Unique identifier of the replication session. string Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response role Use these resource types to manage sessions, roles, and system security configurations. GET /role Description Query roles.
GET /role/{id} Description Query a specific role. Parameters Type Name id Path required Description Schema Unique identifier of the role. string Responses HTTP Code Description Schema 200 Success role_instance 404 Not Found error_response Produces • application/json sas_port Use this resource type to retrieve information about SAS ports. GET /sas_port Description Query the SAS port configuration for all cluster nodes.
GET /sas_port/{id} Description Query a specific SAS port configuration. Parameters Type Name id Path required Description Schema Unique identifier of the SAS port. string Responses HTTP Code Description Schema 200 Success sas_port_instance 404 Not Found error_response security_config system security configuration GET /security_config Description Query system security configurations.
Produces • application/json GET /security_config/{id} Description Query a specific system security configuration. Parameters Type Path Name Description id Unique required configuration. identifier Schema of the system security string Responses HTTP Code Description 200 Success 404 Not Found Schema security_config_in stance error_response Produces • application/json service_config Manage the service configuration for each appliance.
HTTP Code Description Schema < 200 Success service_config_ins tance > array < 206 Partial content of service config instance objects service_config_ins tance > array GET /service_config/{id} Description Query the service configuration instances for an appliance. Parameters Type Name id Path required Description Schema Unique identifier of the instance.
Type Name Body Description Schema body service_config_modi required fy Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Operation Failed error_response service_user Use this resource type to manage the service user account. The system includes the default service_user account with the username 'service'. The service user account cannot authenticate through the REST, CLI, or graphical user interfaces.
HTTP Code Description Schema < 206 Partial content of service user instance objects service_user_insta nce > array Produces • application/json GET /service_user/{id} Description Query the service user account using the unique identifier. Parameters Type Name id Path required Description Schema Unique identifier of the service user.
Type Name id Path required body Body required Description Schema Unique identifier of the service user account. string service_user_modify Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Produces • application/json smb_server Use these resource types to manage Server Message Block (SMB) servers.
HTTP Code Description Schema < 200 Success smb_server_insta nce > array < 206 Partial content of smb server instance objects smb_server_insta nce > array POST /smb_server Description Create an SMB server. Parameters Type Name body Body required Schema smb_server_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /smb_server/{id} Description Query settings of a specific SMB server.
Responses HTTP Code Description 200 Success 404 Not Found Schema smb_server_insta nce error_response DELETE /smb_server/{id} Description Delete a SMB server. The SMB server must not be joined to a domain to be deleted. Parameters Type Name id Path required Description Schema Unique identifier of the SMB server.
Type Name id Path required Description Schema Unique identifier of the SMB server. string body Body smb_server_modify required Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /smb_server/{id}/join Description Join the SMB server to an Active Directory domain.
HTTP Code Description Schema 404 Not Found error_response 422 Operation Failed error_response POST /smb_server/{id}/unjoin Description Unjoin the SMB server from an Active Directory domain. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the SMB server.
Description List SMB shares. Responses HTTP Code Description Schema < 200 smb_share_instan Success ce > array < 206 smb_share_instan Partial content of smb share instance objects ce > array POST /smb_share Description Create an SMB share.
Parameters Type Name id Path required Description Schema SMB Share object id. string Responses HTTP Code Description 200 Success 404 Not Found Schema smb_share_instan ce error_response DELETE /smb_share/{id} Description Delete an SMB Share. Parameters Type Name id Path required Description Schema SMB Share object id.
Parameters Type Name id Path required Description Schema SMB share object id. string body Body optional smb_share_modify Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response smtp_config Use these resource types to configure outgoing SMTP and email notifications. GET /smtp_config Description Query the SMTP configuration. There is always exactly one smtp_config instance.
GET /smtp_config/{id} Description Query the specific SMTP configuration. Parameters Type Name id Path required Description Schema Unique identifier of the SMTP configuration. string Responses HTTP Code Description 200 Success 404 Not Found Schema smtp_config_insta nce error_response PATCH /smtp_config/{id} Description Configure the outgoing SMTP information. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the SMTP configuration.
HTTP Code Description Schema 404 Not Found error_response 422 Operation Failed error_response POST /smtp_config/{id}/test Description Test the SMTP configuration. Parameters Type Name id Path required body Body required Description Schema Unique identifier of the SMTP configuration. string Test operation request body.
Responses HTTP Code Description Schema < 200 snapshot_rule_inst Success ance > array < 206 Partial content of snapshot rule instance objects snapshot_rule_inst ance > array POST /snapshot_rule Description Create a new snapshot rule.
Type Name id Path required Description Schema Unique identifier of the snapshot rule. string Responses HTTP Code Description 200 Success 404 Not Found Schema snapshot_rule_inst ance error_response DELETE /snapshot_rule/{id} Description Delete a snapshot rule Parameters Type Name id Path required Body Description Schema Unique identifier of the snapshot rule.
If the rule is associated with a policy that is currently applied to a storage resource, the modified rule is immediately applied to that associated storage resource. Parameters Type Name id Path required Body Description Schema Unique identifier of the snapshot rule.
HTTP Code Description Schema < 206 Partial content of software installed instance objects software_installed _instance > array GET /software_installed/{id} Description Query a specific item from the list of installed software. Parameters Type Path Name Description id Unique identifier of the installed software to required query.
HTTP Code Description Schema < 200 Success. software_package _instance > array < 206 Partial content of software package instance objects software_package _instance > array POST /software_package Description Push a software package file from the client to the cluster. When successfully uploaded and verified, the result is a software_package in the downloaded state, ready to install.
Description Query a specific software package. Parameters Type Path Name Description id Unique identifier of the software package to required query. Schema string Responses HTTP Code Description 200 Success 404 Not Found Schema software_package _instance error_response DELETE /software_package/{id} Description Delete the specified software package from the cluster. This operation may take some time to complete.
POST /software_package/{id}/install Description Start a software upgrade background job for the specified appliance within the cluster. If an appliance is not specified, the upgrade is performed on all appliances in the cluster. Only specify a subset of appliances to upgrade if the time required to upgrade the entire cluster does not fit within a desired maintenance window.
POST /software_package/{id}/puhc Description Run the pre-upgrade health check for a software package. This operation may take some time to respond. Parameters Type Name id Path required Body Description Schema Unique identifier of the software package.
HTTP Code Description Schema < 200 Success storage_container _instance > array < 206 Partial content of storage container instance objects storage_container _instance > array Produces • application/json POST /storage_container Description Create a virtual volume (vVol) storage container.
Parameters Type Name id Path required Description Schema Storage container ID. string Responses HTTP Code Description 200 Success 404 Not Found Schema storage_container _instance error_response Produces • application/json DELETE /storage_container/{id} Description Delete a storage container. Parameters Type Name id Path required body Body optional Description Schema Storage container ID. string Options to delete storage_container.
HTTP Code Description Schema 422 Operation Failed error_response Produces • application/json PATCH /storage_container/{id} Description Modify a storage container. Parameters Type Name id Path required body Body required Description Schema Storage container ID. string Fields to update.
Parameters Type Name id Path required Body Description Schema Storage container ID. string body storage_container_m optional ount Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /storage_container/{id}/unmount Description Unmount a storage container, which removes the vVol datastore from vCenter.
HTTP Code Description Schema 422 Operation Failed error_response vcenter Use this resource type to manage vCenter instances. Registered vCenter enables discovering of virtual machines, managing virtual machine snapshots, automatic mounting of storage container and other functionality that requires communication with vCenter. In Unified+ deployments, the one vCenter instance residing in the PowerStore cluster will be prepopulated here and cannot be deleted, nor may any other vCenters be added.
HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /vcenter/{id} Description Query a specific vCenter instance. Parameters Type Name id Path required Description Schema Unique identifier of the vCenter to query. string Responses HTTP Code Description Schema 200 Success vcenter_instance 404 Not Found error_response DELETE /vcenter/{id} Description Delete a registered vCenter.
Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /vcenter/{id} Description Modify a vCenter settings. Parameters Type Name id Path required body Body optional Description Schema Unique identifier of the vCenter to modify.
GET /veth_port Description Query virtual Ethernet port configurations. Responses HTTP Code Description Schema < 200 Success veth_port_instanc e > array < 206 Partial content of veth port instance objects veth_port_instanc e > array GET /veth_port/{id} Description Query a specific virtual Ethernet port configuration. Parameters Type Name id Path required Description Schema Unique identifier of the virtual Ethernet port.
virtual_machine Use this resource type to retrieve cached information from vCenter about virtual machines (VMs) that use storage from the cluster or to create a snapshot of a VM. GET /virtual_machine Description Query virtual machines that use storage from the cluster.
DELETE /virtual_machine/{id} Description Delete a virtual machine snapshot. This operation cannot be used on a base virtual machine or virtual machine template. Parameters Type Path Name Description id Unique required snapshot to delete. identifier Schema of the virtual machine string Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response PATCH /virtual_machine/{id} Description Modify a virtual machine.
HTTP Code Description Schema 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /virtual_machine/{id}/snapshot Description Create a snapshot of a virtual machine. This operation cannot be used on a virtual machine snapshot or template. Parameters Type Path Body Name Description id Unique identifier of the virtual machine to required create a snapshot of.
GET /virtual_volume Description Get virtual volumes. Responses HTTP Code Description Schema < 200 Success virtual_volume_in stance > array < 206 Partial content of virtual volume instance objects virtual_volume_in stance > array GET /virtual_volume/{id} Description Get a specific virtual volume. Parameters Type Name id Path required Description Schema Id of the virtual volume.
Parameters Type Name id Path required body Body optional Description Schema Unique identifier of the virtual volume to delete. string Options to delete a virtual volume. virtual_volume_dele te Responses HTTP Code Description Schema 204 Success No Content 404 Not Found error_response 422 Operation Failed error_response volume Manage volumes, including snapshots and clones of volumes. GET /volume Description Query volumes that are provisioned on the appliance.
Parameters Type Name body Body required Schema volume_create Responses HTTP Code Description Schema 201 Created create_response 400 Invalid Request error_response 422 Operation Failed error_response GET /volume/{id} Description Query a specific volume instance. Parameters Type Name id Path required Description Schema Unique identifier of the volume to query.
• A volume which has protection policies attached to it cannot be deleted. • A volume which has snapshots that are part of a snapset cannot be deleted. • Clones of a deleted production volume or a clone are not deleted. • Snapshots of the volume are deleted along with the volume being deleted. Parameters Type Name id Path required Description Schema Unique identifier of the volume to delete.
HTTP Code Description Schema 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response POST /volume/{id}/snapshot Description Create a snapshot of a volume or a clone. The source id of the snapshot is the id of source volume or clone. The source time is the time when the snapshot is created. Parameters Type Path Name Description id Unique identifier of the volume or clone to required create a snapshot of.
Description Create a clone of a volume or snapshot. Parameters Type Path Name Description id Unique identifier of the volume or snapshot to required create a clone of.
Type Path Name Description id Unique identifier of volume for which to refresh required contents. body Body Schema string volume_refresh required Responses HTTP Code Description 200 Success 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Schema volume_refresh_r esponse POST /volume/{id}/restore Description Restore a volume from a snapshot.
Responses HTTP Code Description 200 Success 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response Schema volume_restore_re sponse POST /volume/{id}/attach Description Attach a volume to a host or host group. Parameters Type Name id Path required body Body required Description Schema Unique identifier of volume to attach.
POST /volume/{id}/detach Description Detach a volume from a host or host group. Parameters Type Name id Path required Description Schema Unique identifier of volume to detach. string body Body required volume_detach Responses HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 404 Not Found error_response 422 Operation Failed error_response volume_group Manage volume_groups. A volume_group is a group of related volumes treated as a single unit.
HTTP Code Description Schema < 200 Success volume_group_ins tance > array < 206 Partial content of volume group instance objects volume_group_ins tance > array POST /volume_group Description Create a new volume group. The resulting volume group will have a type of Primary.
Responses HTTP Code Description 200 Success 404 Not Found Schema volume_group_ins tance error_response DELETE /volume_group/{id} Description Delete a volume group, snapshot set, or clone. Before you try deleting a volume group, snapshot set, or clone, ensure that you first detach it from all hosts. Note the following: • When a volume group or clone is deleted, all related snapshot sets will also be deleted. • When a snapshot set is deleted, all of its constituent snapshots will also be deleted.
Parameters Type Name id Path required Body Description Schema Unique identifier of the volume group. string body volume_group_modi optional fy Responses HTTP Code Description Schema 204 Success No Content 400 Invalid request error_response 404 Not Found error_response 422 Invalid Request error_response POST /volume_group/{id}/add_members Description Add member volumes to an existing primary or clone volume group. This cannot be used to add members to a snapshot set.
HTTP Code Description Schema 400 Invalid request error_response 404 Not Found error_response 422 Invalid Request error_response POST /volume_group/{id}/remove_members Description Remove members from an existing primary or clone volume group. This cannot be used to remove members from a snapshot set. Members cannot be removed from a volume group that is a acting as the destination in a replication session.
as the source volume group. A snapshot of a volume group will result in a new volume group of Snapshot type. The snapshot set will belong to the same family as the source volume group. When the source of a snapshot operation is a primary or clone volume group, • source_id of the snapshot set will be set to the identifier of the source volume group. • source_time of the snapshot set will be set to the time at which the snapshot set will be created.
When the source of a clone operation is a snapshot set, • source_id will be set to the source_id of the source snapshot set. • source_time will be set to the source_time of the source snapshot set. The clone volume group will inherit the value of the is_write_order_consistent property from the source volume group. A clone of a snapshot set is modeled as a clone of the snapshot set’s source, created at the same time instant as when the source snapshot set was created.
volume group have changed. This represents a case where the target volumes have been modified over time, but you want to revert them back to their old state captured in the source snapshot set. When a volume group is restored, • source_time is set to the source_time of the snapshot set it is being restored from. A volume group that is acting as the destination in a replication session cannot be restored.
primary (P1)|Current time| |Clone (C1) |snapshot set (S1) of primary (P1)|id of source snapshot set (S1)|source_time of source snapshot set (S1)| |Clone (C1) |Clone (C2)|id of source clone(C2)|Current time| |Clone (C1) |snapshot set (C2S1) of clone (C2)|id of source snapshot set (C2S1)|source_time of source snapshot set (C2S1)| Refresh operation is only supported if there are no membership changes between the source and target volume groups of the refresh operation.
Description Query to list X509 Certificates instances. This resource type collection query does not support filtering, sorting or pagination Responses HTTP Code Description 200 Success Schema < x509_certificate_i nstance > array < 206 Partial content of x 509 certificate instance objects x509_certificate_i nstance > array Produces • application/json GET /x509_certificate/{id} Description Query a specific X509 Certificate instance.
POST /x509_certificate/exchange Description Exchange certificates between two clusters. Add CA certificates to the trust store of each cluster and assign roles to the client certificates. After this process, certificate-based authentication can be used for communication between clusters. This exchange REST API can only be triggered with service Replication_HTTP. Parameters Type Name body Body required Description Request body.
HTTP Code Description Schema 204 Success No Content 400 Invalid Request error_response 422 Operation Failed error_response Produces • application/json Definitions ActivePathEnum Active path of the import host volume. Valid values are: None No active path available. Source Current IO path is set to source. Destination Current IO path is set to destination. Type : enum (None, Source, Destination) AlertStateEnum Alert State Enum with values - Active and Cleared.
PS Peer Storage Group. VNX VNX. Unity Unity. Type : enum (Unknown, SC, PS, VNX, Unity) AuditEventTypeEnum Type of audit event. Authentication All the authentication events on the system. Authorization All the authorization events on the system. Config All the set operations on the system. Example: POST, PATCH, DELETE. System All the system level operations. Logout All the logging out events on the system. Type : enum (Authentication, Authorization, Config, System, Logout) BondingModeEnum Bond mode.
Ready The consistency group is ready for nondisruptive import. Ready_For_Agentless_Import The consistency group is ready for agentless import. In_Progress Import is in progress. Members_Not_Ready The member or members of teh consistency group are not ready for import. No_Members There are no members in the consistency group. Max_Members The maximum number of members for a consistency group has been exceeded. Not_In_Sync The array must be refreshed. Imported Import is complete.
ClusterStateEnum Possible cluster states. * Unconfigured_Faulted - This is single appliance that is not in a cluster and Hardware is in faulted state. * Unconfigured - This is a single appliance that is not in a cluster. * Configured - Cluster is configured and operational. * Configuring - Cluster is in the process of initial setup. * Expanding - Appliance(s) are being added to the cluster. * Removing - Appliance(s) are being removed from the cluster.
Monday Monday Tuesday Tuesday Wednesday Wednesday Thursday Thursday Friday Friday Saturday Saturday Sunday Sunday Unknown Day of week is unknown to PowerStore. Type : enum (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Unknown) DaysOfWeekEnum Days of the week. Type : enum (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday) EthPortSpeedEnum Supported Ethernet front-end port transmission speeds.
1_Gbps 1 Gigabits per second 10_Gbps 10 Gigabits per second 25_Gbps 25 Gigabits per second 40_Gbps 40 Gigabits per second Type : enum (Auto, 10_Mbps, 100_Mbps, 1_Gbps, 10_Gbps, 25_Gbps, 40_Gbps) FcPortSpeedEnum Possible Fibre Channel port speeds. For the current_speed attribute, these values show the current transmission speed on the port. For the requested_speed attribute, these values show the transmission speed set by the user.
Type : enum (UDP, TCP) FileInterfaceRoleEnum Production This type of network interface is used for all file protocols and services of a NAS server. This type of interface is inactive while a NAS server is in destination mode. Backup This type of network interface is used only for NDMP/NFS backup or disaster recovery testing. This type of interface is always active in all NAS server modes.
Kerberos Kerberos authentication means the NAS Server uses a KDC to confirm the identity when accessing the Active Directory. Type : enum (Anonymous, Simple, Kerberos) FileLDAPProtocolEnum Indicates whether the LDAP protocol uses SSL for secure network communication. SSL encrypts data over the network and provides message and server authentication. LDAP LDAP protocol without SSL. LDAPS (Default) LDAP protocol with SSL.
Hard_Reached Hard limit is reached. Type : enum (Ok, Soft_Exceeded, Soft_Exceeded_And_Expired, Hard_Reached) FileSystemAccessPolicyEnum File system security access policies. Each file system uses its access policy to determine how to reconcile the differences between NFS and SMB access control. Selecting an access policy determines which mechanism is used to enforce file security on the particular file system. Native Native Security. UNIX UNIX Security. Windows Windows Security.
Advisory No lock checking for NFS and honor SMB lock range only for SMB. Mandatory Honor SMB and NFS lock range. Type : enum (Advisory, Mandatory) FileSystemSnapshotAccessTypeEnum Indicates whether the snapshot directory or protocol access is granted to the file system snapshot. Snapshot Snapshot access is via the .snapshot folder in the file system. Protocol Protocol access is via normal file shares.
AppSync Created by AppSync. Type : enum (Scheduler, User) FileSystemTypeEnum Primary Normal file system or clone. Snapshot Snapshot of a file system. Type : enum (Primary, Snapshot) ForecastMetricTypeEnum Metric type to be forecast. Type : enum (Physical_Space_Used_One_Day) ForecastTimeToFullStatusEnum Type of alert indicated for object based on projected time to full. OK Time to full value is greater than 28 days. No alert indicated.
Subscriber Connector FC_Style1_Copper Fibre Channel Style 1 Copper Connector FC_Style2_Copper Fibre Channel Style 1 Copper Connector BNC_TNC Bayonet/Threaded Neill-Concelman Connector FC_Coaxial_Headers Fibre Channel Coaxial Headers Connector FiberJack Fiber Jack Connector LC Lucent Connector MT_RJ Mechanical Transfer - Registered Jack Connector MU Multiple Optical Connector SG SG Connector Optical_Pigtail Optical Pigtail Connector HSSDC_II High Speed Serial Data Connector Copper_Pigtail Copper Pigtail Conn
MXC_2x16) HAOSTypeEnum Operating system of the import host system. Valid values are: Windows Windows. Linux Linux. ESXi ESXi. Unknown Operating system of the host system is unknown to PowerStore. Type : enum (Windows, Linux, ESXi, Unknown) HardwareDriveEncryptionStatusEnum Indicates whether the drive is currently encrypted or not. Available on the Drive hardware type. Current statuses are: Not_Supported Drive does not support encryption. Supported_Unlocked Drive supports encryption but is not configured.
Type : enum (Not_Supported, Supported_Locked_Cluster_PIN, Supported_Unlocked, Supported_Locked_Out, Supported_Locked, Supported_Locked_Foreign, Supported_Processing, Disabled) HardwareDriveFIPSStatusEnum FIPS compliance level. Available on the Drive hardware type. Current compliance levels are: FIPS_Compliance_None Drive has no FIPS compliance. FIPS_Compliance_Level_1 Drive has Level 1 FIPS 140-2 compliance. FIPS_Compliance_Level_2 Drive has Level 2 FIPS 140-2 compliance.
Uninitialized System is starting up. Healthy Hardware is healthy. Initializing System is starting up. Failed Hardware has failed. Disconnected Hardware was removed from the system. Prepare_Failed Transient state used during startup. Trigger_Update Transient state used during startup. Empty No hardware present in this location. Type : enum (Uninitialized, Healthy, Initializing, Failed, Disconnected, Prepare_Failed, Trigger_Update, Empty) HardwareSFPConnectorTypeEnum Connector type.
FiberJack Fiber Jack Connector LC Lucent Connector MT_RJ Mechanical Transfer - Registered Jack Connector MU Multiple Optical Connector SG SG Connector Optical_Pigtail Optical Pigtail Connector HSSDC_II High Speed Serial Data Connector Copper_Pigtail Copper Pigtail Connector RJ45 RJ45 Connector No_Separable Non-seperable Connector MXC_2x16 MXC 2x16 Connector Type : enum (Unknown, SC, FC_Style1_Copper, FC_Style2_Copper, BNC_TNC, FC_Coaxial_Headers, FiberJack, LC, MT_RJ, MU, SG, Optical_Pigtail, HSSDC_II, Copp
This SFP supports single-mode fiber. Type : enum (Unknown, Multi_Mode, Single_Mode) HardwareSFPSpeedEnum Supported speed. Available on the SFP hardware type.
Unknown This SFP has unknown protocol support. FC This SFP supports Fibre Channel. Ethernet This SFP supports Ethernet. FC_Ethernet This SFP supports Fibre Channel or Ethernet. SAS This SFP supports SAS for connections to Expansion Enclosures. Type : enum (Unknown, FC, Ethernet, FC_Ethernet, SAS) HardwareStatusLEDStateEnum State of the status LED of the hardware. The LED is On when there is a hardware fault. Current values are: Off Hardware Status LED is turned off. On Hardware Status LED is turned on.
IO_Module The component that provides front-end I/O connectivity to each Node. Link_Control_Card The IO card that provides SAS Connectivity to the Expansion Enclosure. SFP The Small Form-factor Pluggable (SFP) that is used for networking. Battery The internal battery backup used by each Node. DIMM The memory sticks that are installed in each Node. M2_Drive The internal M.2 SATA drive used for Node boot and recovery. Fan The fan module that provides cooling to the Node.
HostAgentTypeEnum Type of import host system. Valid values are: EQL EQL MPIO. Native_MPIO Native MPIO. Power_Path POWER PATH MPIO. Unknown Type of host agent is unknown to PowerStore. Type : enum (EQL, Native_MPIO, Power_Path, Unknown) HostInitiatorProtocolTypeEnum Protocol type of the import host initiator. Valid values are: Other Protocol type is other. iSCSI Protocol type is internet SCSI. FC Protocol type is Fibre Channel. FCoE Protocol type is Fibre Channel over Ethernet.
ImportOperationStatusEnum Migration state of the import host volume. Valid values are: Import_Completed Import operation was successful. Cancel_Completed Cancel operation was successful. Import_Aborted Aborted the ongoing import. Cancel_Aborted Aborted the ongoing cancel operation. Cancel_Forced Aborted the ongoing cancel operation. None Migration state is not known to PowerStore.
Hourly Take snapshot hourly. Daily Take snapshot on a daily basis. Weekly Take snapshot on a weekly basis. Monthly Take snapshot on a monthly basis. Type : enum (Once, Hourly, Daily, Weekly, Monthly) ImportSessionStateEnum Import session states Scheduled Indicates that a user scheduled the import to run at a later time. The import remains in this state and waits until the schedule expires. Paused Indicates that the data copy between the source and destination volumes is paused.
Ready_For_Cutover Indicates that you can commit the import. The import process moves to this state after it successfully copies data from the source volume or consistency group. Cutover_In_Progress Indicates that the cutover of volumes that are part of a consistency group is in progress. Import_Completed Indicates that all operations completed successfully for a given import after a commit. In this state, the source volume is no longer mapped to the host and all stale paths are cleaned up.
Type : enum (Scheduled, Paused, Queued, In_Progress, Mirror_Enabled, Ready_To_Start_Copy, Copy_In_Progress, Ready_For_Cutover, Cutover_In_Progress, Import_Completed, Cancelled, Failed, Cancel_Failed, Cancel_In_Progress, Cleanup_In_Progress, Cleanup_Failed, Invalid, Cleanup_Required, Import_Completed_With_Errors, Import_Cutover_Incomplete) ImportStatusEnum Migration state of the volume. Valid values are: None Volume is not migrated. Normal Volume state is normal.
IoPriorityEnum The I/O priority for quality of service rules. Type : enum (Low, Medium, High) IpPortUsageEnum IP port usages. Management Can be used for the public management network. ISCSI Can be used for the public storage network. ISCSI_Default Is used for default storage connections and cannot be uscaled. External_Replication Can be used for the external data mobility traffic. Type : enum (Management, ISCSI, ISCSI_Default, External_Replication) IpPurposeTypeEnum Network IP address purpose.
LocationHistoryReasonEnum Reason for storage resource relocation. Initial Initial placement. Manual Manual migration operation initiated by user. Recommended Storage system recommended migration. Type : enum (Initial, Manual, Recommended) MessageSeverityEnum Message severity. Type : enum (Info, Warning, Error) MetricsEntityEnum An enum describing the various entities supported by metrics. performance_metrics_by_appliance Appliance performance metrics. performance_metrics_by_node Node performance metrics.
performance_metrics_by_fe_eth_node Frontend ethernet performance metrics for node. performance_metrics_by_fe_fc_node Frontend fibre channel performance metrics for node. wear_metrics_by_drive Drive wear metrics.
performance_metrics_smb_by_node Performance metrics for the SMB protocol global performance_metrics_smb_builtinclient_by_node Performance metrics for the SMB protocol built-in client performance_metrics_smb_branch_cache_by_node Performance metrics for the SMB protocol Branch-Cache performance_metrics_smb1_by_node Performance metrics for the SMB1 protocol basic performance_metrics_smb1_builtinclient_by_node Performance metrics for the SMB1 protocol built-in client performance_metrics_smb2_by_node Performance
Type : enum (Twenty_Sec, Five_Mins, One_Hour, One_Day) MigrationRecommendationActionStateEnum State of a recommended migration action. Recommendation_Created This action has been recommended, but no other action has been taken. Migration_Session_Created A migration session was successfully created for this recommended action. Migration_Session_Create_Failed A migration session could not be created for this recommended action.
Valid scopes for migrations are: volume Standalone attached/unattached volume family. virtual_volume Standalone attached/unattached virtual volume family. host Logical group of all volume families attached to a host. virtual_machine Logical group of all virtual volume families attached to a virtual machine. volume_group Volume group family with or without host attachment.
Recommendation_Created Recommended actions meet all request parameters. Some_Actions_Recommended Recommendation generated, but not all request parameters satisfied. Migration_Session_Created Migration sessions were successfully created for each recommended migration action. Migration_Session_Create_Failed A migration session could not be created for at least one recommended recommended actions.
MigrationResourceTypeEnum Storage resource types eligible for migration. Type : enum (volume, virtual_volume, volume_group) MigrationSessionStateEnum Migration session states. Initializing Migration session starts and stays in this state until the session initialization completes. Initialized Migration session transitions to this state when session initialization completes. Synchronizing Background copy is in progress. Idle Migration session transitions to this state when initial background copy completes.
Type : enum (Initializing, Initialized, Synchronizing, Idle, Cutting_Over, Deleting, Completed, Pausing, Paused, System_Paused, Resuming, Failed) MigrationStateEnum Migration status of a volume. Valid values are: Legacy Volume state is normal. Preparing Volume is prepared for migration. Disabled_For_IO Volume is disabled for IO from host. In_Progress Volume migration is in progress. Done Volume is migrated.
April April May May June June July July August August September September October October November November December December Unknown Month of year is unknown to PowerStore. Type : enum (January, February, March, April, May, June, July, August, September, October, November, December, Unknown) NASServerCurrentUnixDirectoryServiceEnum Define the Unix directory service used for looking up identity information for Unix such as UIDs, GIDs, net groups, and so on.
Starting NAS server is starting. Started NAS server is started. Stopping NAS server is stopping. Failover NAS server has failed over. Degraded NAS server is degraded (running without backup). Unknown NAS server state is unknown. Type : enum (Stopped, Starting, Started, Stopping, Failover, Degraded, Unknown) NFSExportDefaultAccessEnum Default access level for all hosts that can access the Export. No_Access Deny access to the Export for the hosts. Read_Only Allow read only access to the Export for the hosts.
Kerberos Allow only Kerberos security for user authentication. Kerberos_With_Integrity Allow only Kerberos with integrity and Kerberos with encryption security for user authentication. Kerberos_With_Encryption Allow only Kerberos with encryption security for user authentication. Type : enum (Sys, Kerberos, Kerberos_With_Integrity, Kerberos_With_Encryption) NetworkTypeEnum Network type.
OSTypeEnum Operating system of the host. Type : enum (Windows, Linux, ESXi, AIX, HP-UX, Solaris) PhysicalSwitchConnectMethodEnum Physical switch connect method type. Valid values are: SSH Secure shell. SNMPv2c SNMPv2 community string. Type : enum (SSH, SNMPv2c) PhysicalSwitchPurposeEnum Physical switch purpose in network. Possible purposes are: Data_and_Management Physical switch for all data and management networks. Management_Only Physical switch for management network only.
One_Day) RemoteSystemChapModeEnum Challenge Handshake Authentication Protocol (CHAP) status: • Disabled Single Enabled for initiator authentication. Mutual Enabled for initiator and target authentication. Type : enum (Disabled, Single, Mutual) RemoteSystemLatencyEnum Network latency choices for a remote system. Replication traffic can be tuned for higher efficiency depending on the expected network latency. This will only be used when the remote system type is PowerStore. Low Less than 5 milliseconds.
PowerStore PowerStore system Unity Unity import system VNX VNX import system PS_Equallogic PS EqualLogic import system Storage_Center Storage Center import system XtremIO XtremIO import system Type : enum (PowerStore, Unity, VNX, PS_Equallogic, Storage_Center, XtremIO) ReplicatedResourceTypeEnum Storage resource types eligible for replication protection: volume Replication session created on a volume. * volume_group - Replication session created on a volume group.
OK No other operation. The replication session is operating normally. Synchronizing The replication session has started either a manual or automatic synchronization. System_Paused Replication session operation has failed or was cancelled. User intervention required. Paused User paused the replication session. Paused_For_Migration Migration paused the replication session. Paused_For_NDU A non-disruptive upgrade paused the replication session. Resuming The replication session is resuming operation.
ResourceActionEnum User-specified action to be performed on the given resource.
Volume migration state is unknown to PowerStore. Type : enum (Up, Down, Degraded, Unknown) SMBShareOfflineAvailabilityEnum Defines valid states of Offline Availability, Manual Only specified files will be available offline. Documents All files that users open will be available offline. Programs Program will preferably run from the offline cache even when connected to the network. All files that users open will be available offline.
Weekly Take snapshot on a weekly basis. Monthly Take snapshot on a monthly basis. Unknown SC schedule type is unknown to PowerStore. Type : enum (Once, Daily, Weekly, Monthly, Unknown) ScSnapshotProfileTypeEnum Available SC snapshot profile types. Valid values are: Standard Takes snapshots in series for all volumes associated with the snapshot. Parallel Takes snapshots simultaneously for all volumes associated with the snapshot.
Available The package is ready to be downloaded. Downloaded The package is downloaded and ready to install. Installing The package is being installed. Installed The package has been successfully installed. Install_Failed Installing the package failed. Download_Failed Downloading the package failed. Type : enum (Available, Downloaded, Installing, Installed, Install_Failed, Download_Failed) SoftwarePackageTypeEnum Software package type.
StorageElementTypeEnum Storage element type being replicated: volume Replicating storage element type for a volume. virtual_volume Replicating storage element type for a virtual volume. Type : enum (volume, virtual_volume) ThumbprintAlgorithmEnum The thumbprint algorithm: - SHA-256 : SHA-256 algorithm Type : enum (SHA-256) TransitConnectionStatusEnum Possible transit connection statuses: Login_Success Login to target IP successful. Authentication_Failure Failed to authenticate the connection.
Discovery_Connection_Refused Connection was refused during discovery of target IP. Discovery_Timeout Discovery of target IP timed out. Type : enum Network_Error, (Login_Success, Authentication_Failure, General_Failure, Connection_Refused, Login_Success_No_Ports, Login_Timeout, Discovery_Success, Discovery_Authentication_Failure, Discovery_Connection_Refused, Discovery_Timeout) UnityDayofWeekEnum Days of the week. Values are: Sunday Sunday. Monday Monday. Tuesday Tuesday. Wednesday Wednesday.
Ok The system is operating normally. Ok_But The system is operating normally but there are potential issues. Degraded The system is working, but performance may not be optimum. Minor The system is working, but it has experienced one or more minor failures. Major The system is failing; some or all of its functions may be degraded or not working. This condition has a significant impact on the system and should be remedied immediately. Critical The system has failed and recovery may not be possible.
Nth_Day_Of_Month_AT_HHMM Create a snapshot on the selected {daysOfMonth}, at the time {hours}:{minutes}. Supported parameters: daysOfMonth (at least one required), hours (optional, default 0), minutes (optional, default 0). Unsupported Unsupported. Unknown Schedule type is unknown to PowerStore. Type : enum (N_Hours_At_MM, Day_At_HHMM, N_Days_At_HHMM, SelDays_At_HHMM, Nth_Day_Of_Month_AT_HHMM, Unsupported, Unknown) UnityScheduleVersionEnum Type of snapshot schedule.
Aborted Volume migration is cancelled. Not_Applicable Volume migration state is not applicable if the system only supports agentless import. Unknown The volume migration state is unknown to PowerStore. Type : enum (Normal, Source_Migration_In_Progress, Prepare_For_Migration, Source_Migration_Completed, Source_Disabled_For_IO, Source_Migration_Aborted, Unknown) UnityVolumeTypeEnum Type of the Unity volume. Values are: Unknown Volume type cannot be determined.
Green VM is operating normally. Yellow VM is operating normally, but there are potential issues. Red VM is experiencing issues and is not operating normally. Grey Status of the VM cannot be determined. Type : enum (Green, Yellow, Red, Gray) VirtualMachineTypeEnum Type of VM: Primary A base VM. Template A VM template. Snapshot A snapshot of a VM. Type : enum (Primary, Template, Snapshot) VirtualVolumeTypeEnum The logical type of a virtual volume.
system only supports agentless import. * Unknown - The volume migration state cannot be determined. Type : enum (None, Prepared, Disabled_For_IO, In_Progress, Completed, Aborted, Not_Applicable, Unknown) VnxVolumeStateEnum State of the VNX volume. Only volumes that are in the Ready or Default state can be imported.
Imported Import is complete. Incompatible_Firmware The software version on the source array is not compatible. Incompatible_Host_Agent The agent version on the host is not compatible. Undetermined The import status cannot be determined due to an internal error. Contact technical support. Host_Volume_Offline The host volume is offline. Cluster_Node_Count_MisMatch The host or hosts added to the appliance are not part of the host cluster to which the volume is mapped.
VNX_Internal_Volume The VNX volume is an internal volume. Unity_System_Health_Inappropriate The health of the Unity system is not suitable for import. Unity_Volume_Health_Inappropriate The health of the Unity volume is not suitable for import. XtremIO_Severity_Inappropriate The severity level of the XtremIO system is not suitable for import. XtremIO_State_Inappropriate The state of the XtremIO system is not suitable for import.
Unknown Volume status is unknown. Online Volume is online. Offline Volume is offline. Type : enum (Unknown, Online, Offline) VolumeTypeEnum Type of volume. Primary A base object. Clone A read-write object that shares storage with the object from which it is sourced. Snapshot A read-only object created from a volume or clone. Type : enum (Primary, Clone, Snapshot) WeekOfMonthEnum Weeks of the month.
Type : enum (First, Second, Third, Fourth, Last, Unknown) X509CertificateServiceEnum Type of the service for which the certificate is used: • Management HTTP - Management Web server • Replication HTTP - Remote Replication service • VASA HTTP - VASA provider service • Import HTTP - External web service Type : enum (Management_HTTP, Replication_HTTP, VASA_HTTP, Import_HTTP) X509CertificateUsageTypeEnum Usage of the certificate and the valid values are: Server Server Certificate Client Client Certificate • C
Name fc_port_id optional Description Unique identifier of the FC port the initiator is logged into. Null if one of the following is non-null: bond_id, veth_id or string eth_port_id node_id Unique identifier of node on the appliance on which active optional session is create. port_name IQN or WWN of the target port that the initiator is logged optional into. veth_id optional Schema string string Unique identifier of the virtual Ethernet port the initiator is logged into.
Name event_code optional Description Schema The event code of the latest event for this alert. string events List of events associated with this alert. Filtering on the < event_instance > optional fields of this embedded resource is not supported. array Timestamp of the latest event for this alert. string (date-time) Unique identifier of the alert. string Whether an alert has been acknowledged. boolean Timestamp of the first event for this alert.
Name state_l10n optional Description Schema Localized message string corresponding to state string alert_modify Alert modify request body. Name Description Schema acknowledged _severity SeverityEnum optional is_acknowledg ed Indicates whether the alert has been acknowledged.
Name timestamp optional Description Schema Date-time of the forecast data. string (date-time) appliance_instance This resource type has queriable associations from node, ip_pool_address, veth_port, maintenance_window, fc_port, sas_port, eth_port, software_installed, virtual_volume, hardware, volume Name eth_ports optional Description Schema This is the inverse of the resource type eth_port association. < eth_port_instance > array express_servi ce_code Express Service Code.
Name nodes optional sas_ports optional service_tag optional software_inst alled optional Description Schema This is the inverse of the resource type node association. This is the inverse of the resource type sas_port association. Dell Service Tag. < node_instance > array < sas_port_instance > array string This is the inverse of the resource type software_installed association.
Name appliance_id optional end_of_foreca st optional Description Schema Unique ID of appliance. string Timestamp of the end of the capacity forecast. If time to full estimates are null, the relevant forecast does not reach full capacity before it ends. In this case the end of the forecast can be used as a minimum for time to full. time_to_full Estimated date-time at which the forecast value will reach optional full capacity.
Name Description job_id Unique identifier of the job associated with the audit event optional (if any). Schema string message_argu ments Arguments (if applicable) for the audit_event message. < string > array Unique identifier of the message for this audit_event. string Localized message string corresponding to message_code.
base_copy_metrics_by_appliance Copy metrics for the appliance. Name appliance_id optional data_remaini ng optional Description Schema Unique identifier of the appliance. string Number of bytes remaining to be copied at the end of this sampling period. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 data_transfer Number of bytes transferred during this sampling period.
Name Description Schema Time (in milliseconds) spent doing writes during this write_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 base_copy_metrics_by_cluster Copy metrics for the cluster. Name data_remaini ng optional Description Schema Number of bytes remaining to be copied at the end of this sampling period.
Name Description Schema The time (in milliseconds) spent in copy activity during this transfer_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Time (in milliseconds) spent doing writes during this write_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 base_copy_metrics_by_remote_system Cluster wide copy metrics for the remote system.
Name Description Schema Localized message string corresponding to session_type string End of sampling period. string (date-time) session_type_l 10n optional timestamp optional transfer_rate Data transfer rate (in bytes/second) computed using optional data_transferred and transfer_time. number (float) The time (in milliseconds) spent in copy activity during this transfer_time sampling period.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 session_type CopySessionTypeEn optional um session_type_l 10n Localized message string corresponding to session_type string End of sampling period.
Name Description data_transfer Number of bytes transferred during this sampling period. red Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) Time (in milliseconds) spent doing reads during this read_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values.
base_performance_metrics_by_appliance Performance metrics for the appliance collected at twenty second interval. Name appliance_id optional avg_io_size optional avg_latency optional Description Schema Unique identifier representing a specific appliance. string Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes.
Name Description Schema Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number Write rate in bytes per second. number (float) Total write operations per second.
Name Description Schema Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) max_avg_writ e_latency optional max_avg_writ e_size optional max_io_workl The maximum percentage of CPU Utilization on the cores oad_cpu_utiliz dedicated to servicing storage I/O requests. Calculated over ation time interval across appliance. Derived from an average of optional utilization across all nodes within the appliance.
base_performance_metrics_by_cluster Performance metrics for the cluster collected at twenty second interval. Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
Name total_iops optional Description Schema Total read and write operations per second. number (float) Write rate in byte/sec. number (float) Total write operations per second. number (float) write_bandwi dth optional write_iops optional base_performance_metrics_by_cluster_rollup Summary of cluster level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period.
Name Description Schema Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes. number (float) Identifier of the cluster.
Name Description Schema Maximum read bandwidth in bytes per second. number (float) Maximum reads per second. number (float) Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum write bandwidth in bytes per second. number (float) Maximum writes per second.
Name bytes_tx_ps optional Description Schema The total bytes transmitted per second. number (float) node_id Reference to the associated node on which these metrics optional were recorded. pkt_rx_crc_er ror_ps optional pkt_rx_no_buf fer_error_ps optional pkt_rx_ps optional pkt_tx_error_ ps optional pkt_tx_ps optional repeat_count optional timestamp optional The number of packets received with CRC error (and thus dropped) per second.
Name Description Schema The average total bytes transmitted per second. number (float) avg_bytes_tx_ ps optional avg_pkt_rx_cr c_error_ps optional The average number of packets received with CRC error (and thus dropped) per second. number (float) avg_pkt_rx_no _buffer_error_ The average number of packets discarded per second due ps to lack of buffer space.
Name max_pkt_tx_e rror_ps optional Description Schema The maximum number of packets that failed to be transmitted per second due to error. number (float) max_pkt_tx_p s The maximum number of packets transmitted per second. number (float) optional node_id Reference to the associated node on which these metrics optional were recorded. repeat_count optional timestamp optional string Number of times the metrics are repeated.
Name pkt_rx_no_buf fer_error_ps optional pkt_rx_ps optional pkt_tx_error_ ps optional pkt_tx_ps optional repeat_count optional timestamp optional Description The number of packets discarded per second due to lack of buffer space. The number of packets received per second. The number of packets that failed to be transmitted per second due to error. The number of packets transmitted per second.
Name Description Schema avg_pkt_rx_no _buffer_error_ The average number of packets discarded per second due ps to lack of buffer space. number (float) optional avg_pkt_rx_ps optional avg_pkt_tx_er ror_ps optional avg_pkt_tx_ps optional The average number of packets received per second. number (float) The average number of packets that failed to be transmitted per second due to error. The average number of packets transmitted per second.
Name Description Schema The maximum number of packets transmitted per second. number (float) Reference to the node the port belongs to. string max_pkt_tx_p s optional node_id optional repeat_count optional timestamp optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) base_performance_metrics_by_fe_fc_node Fibre channel performance metrics for the node collected at twenty second interval.
Name Description Schema Dumped frames per second. number (float) Invalid crc count per second. number (float) Invalid transmission word count per second. number (float) Link failure count per second. number (float) Loss of signal count per second. number (float) Loss of sync count per second.
Name Description Schema Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number (float) Unaligned read/write rate in bytes per second. number (float) Unaligned total input/output per second. number (float) Unaligned read rate in bytes per second. number (float) Unaligned read input/output per second. number (float) te_bandwidth Unaligned write rate in bytes per second.
Name Description avg_current_l Average number of logins to the target from initiators. ogins Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) avg_dumped_f rames_ps Average dumped frames per second. number (float) Average invalid crc count per second. number (float) Average invalid transmission word count per second. number (float) Average size of read and write operations in bytes. number (float) Weighted average latency in microseconds.
Name avg_read_iops optional Description Schema Average reads per second. number (float) Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number Average unaligned read/write rate in bytes per second. number (float) Average unaligned total input/output per second.
Name Description Schema Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes. number (float) avg_write_ban dwidth optional avg_write_iop s optional avg_write_late ncy optional avg_write_size optional max_avg_io_si ze optional Maximum average size of input and output operations in bytes.
Name Description Schema The maximum dumped frames per second. number (float) The maximum invalid crc count per second. number (float) max_dumped_ frames_ps optional max_invalid_c rc_count_ps optional max_invalid_t x_word_count _ps The maximum invalid transmission word count per second. number (float) optional max_link_fail ure_count_ps The maximum link failure count per second. number (float) The maximum loss of signal count per second. number (float) The maximum loss of sync count per second.
Name Description Schema Maximum totals per second. number Maximum unaligned read/write rate in bytes per second. number (float) Maximum unaligned total input/output per second. number (float) Maximum unaligned read rate in bytes per second. number (float) Maximum unaligned read input/output per second. number (float) Maximum unaligned write rate in bytes per second. number (float) Maximum unaligned write input/output per second. number (float) Maximum write bandwidth in bytes per second.
Name timestamp optional Description Schema End of sample period. string (date-time) base_performance_metrics_by_fe_fc_port Performance metrics for the frontend fibre channel port collected at twenty second interval. Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. avg_io_size optional avg_latency optional Schema string Average size of read and write operations in bytes.
Name Description Schema Invalid crc count per second. number (float) Invalid transmission word count per second. number (float) Link failure count per second. number (float) Loss of signal count per second. number (float) Loss of sync count per second. number (float) Reference to the node the port belongs to.
Name Description Schema Total read and write operations per second. number (float) Unaligned read/write rate in bytes per second. number (float) Unaligned total input/output per second. number (float) Unaligned read rate in bytes per second. number (float) Unaligned read input/output per second. number (float) te_bandwidth Unaligned write rate in bytes per second.
Name Description avg_current_l Average number of logins to the target from initiators. ogins Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) avg_dumped_f rames_ps Average dumped frames per second. number (float) Average invalid crc count per second. number (float) Average invalid transmission word count per second. number (float) Average size of read and write operations in bytes. number (float) Weighted average latency in microseconds.
Name avg_read_iops optional Description Schema Average reads per second. number (float) Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number Average unaligned read/write rate in bytes per second. number (float) Average unaligned total input/output per second.
Name Description Schema Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes. number (float) avg_write_ban dwidth optional avg_write_iop s optional avg_write_late ncy optional avg_write_size optional fe_port_id Reference to the associated frontend fibre channel port optional (fc_port) on which these metrics were recorded.
Name Description Schema max_current_ Maximum number of logins to the target from initiators. logins Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_dumped_ frames_ps The maximum dumped frames per second. number (float) The maximum invalid crc count per second. number (float) optional max_invalid_c rc_count_ps optional max_invalid_t x_word_count _ps The maximum invalid transmission word count per second.
Name Description Schema Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum unaligned read/write rate in bytes per second. number (float) Maximum unaligned total input/output per second. number (float) Maximum unaligned read rate in bytes per second. number (float) Maximum unaligned read input/output per second. number (float) Maximum unaligned write rate in bytes per second. number (float) Maximum unaligned write input/output per second.
Name repeat_count optional timestamp optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) base_performance_metrics_by_file_system Performance metrics for the file system collected at twenty second interval. Name avg_latency optional Description Schema Average read and write latency in microseconds. number (float) Average read latency in microseconds.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp optional End of sample period. string (date-time) Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number (float) Write rate in bytes per second.
Name avg_read_size optional avg_size optional Description Schema Average read size in bytes. number (float) Average read and write size in bytes. number (float) Average data transfer rate in bytes per second. number (float) Average read and write operations per second. number (float) Average write rate in bytes per second. number (float) Average write operations per second. number (float) Maximum of average write latency in microseconds. number (float) Average write size in bytes.
Name max_avg_size optional Description Schema Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum read and write operations per second. number (float) Maximum read rate in bytes per second. number (float) Maximum read operations per second. number (float) Maximum data transfer rate in bytes per second.
base_performance_metrics_by_nfs Performance metrics for the nfs collected at twenty second interval. Name avg_io_size optional avg_latency optional Description Schema Average read and write size in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
base_performance_metrics_by_nfs_rollup Summary of nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name avg_io_size optional avg_latency optional avg_read_iops optional Description Schema Average read and write size in bytes. number (float) Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds.
Name Description Schema Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
Name Description Schema Average md latency operations per second. number (float) Total failed md operations per second. number (float) Total md operations per second. number (float) Unique identifier of the nfs. string Total read iops in microseconds. number (float) avg_md_laten cy optional failed_md_ops optional md_ops optional node_id optional read_iops optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values.
Name Description Schema Average md latency per second. number (float) Average md operations per second. number (float) Average read operations per second. number (float) Average read and write operations per second. number (float) Average write operations per second. number (float) Maximum average md latency per second. number (float) Max failed operations per second. number (float) Maximum read operations per second. number (float) Maximum read and write operations per second.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp optional Time at the beginning of sample period. string (date-time) base_performance_metrics_by_nfsv4 Performance metrics for the nfs collected at twenty second interval.
Name write_iops optional Description Schema Total write iops in microseconds. number (float) base_performance_metrics_by_nfsv4_rollup Summary of nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name Description Schema Average failed operations per second. number (float) Average md latency per second. number (float) Average md operations per second. number (float) Average read operations per second.
Name Description Schema Maximum read and write operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node. string max_total_iop s optional max_write_io ps optional node_id optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats).
Name Description Schema Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional current_login The number of logins to the target from initiators. s Minimum value : 0 optional Maximum value : 9223372036854775807 io_workload_c pu_utilization optional node_id optional The percentage of CPU Utilization on the cores dedicated to servicing storage I/O requests.
Name Description Schema Unaligned total input/output per second. number (float) Unaligned read rate in bytes per second. number (float) Unaligned read input/output per second. number (float) te_bandwidth Unaligned write rate in bytes per second. number (float) unaligned_iop s optional unaligned_rea d_bandwidth optional unaligned_rea d_iops optional unaligned_wri optional unaligned_wri te_iops Unaligned write input/output per second. number (float) Write rate in byte/sec.
Name Description Schema avg_io_worklo The average percentage of CPU Utilization on the cores ad_cpu_utiliza dedicated to servicing storage I/O requests. Calculated over tion time across appliance. Derived from an average of optional utilization across all nodes within the appliance. avg_latency optional number (float) Weighted average latency in microseconds. number (float) Weighted average read bandwidth in bytes per second. number (float) Average reads per second.
Name Description Schema Average unaligned read input/output per second. number (float) Average unaligned write rate in bytes per second. number (float) Average unaligned write input/output per second. number (float) Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) max_avg_writ e_latency optional max_avg_writ e_size optional max_current_ Maximum number of logins to the target from initiators. logins Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_io_workl The maximum percentage of CPU Utilization on the cores oad_cpu_utiliz dedicated to servicing storage I/O requests.
Name Description Schema Maximum unaligned read rate in bytes per second. number (float) Maximum unaligned read input/output per second. number (float) Maximum unaligned write rate in bytes per second. number (float) Maximum unaligned write input/output per second. number (float) Maximum write bandwidth in bytes per second. number (float) Maximum writes per second. number (float) Unique identifier representing a specific node.
Name Description Schema Average hash latency. number (float) Average hash size. number (float) Max hash latency. number (float) Max hash size. number (float) Min hash latency. number (float) Max hash size. number (float) Max used threads number (float) Unique identifier of the node.
base_performance_metrics_by_smb_cache_rollup Performance metrics nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name Description Schema Average hash latency. number (float) Average hash size. number (float) Average max hash latency. number (float) Average max hash size. number (float) Max hash latency. number (float) Max hash size. number (float) Min hash latency. number (float) Max hash size.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp optional End of sample period. string (date-time) Total rejected task. number (float) Total tasks.
Name node_id optional read_iops optional Description Schema Unique identifier of the node. string Total read operations per second. number (float) Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats).
Name avg_read_iops optional Description Schema Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes. number (float) Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes.
Name max_calls optional max_iops optional Description Schema Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node. string max_read_iop s optional max_write_io ps optional node_id optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values.
Name avg_read_size optional Description Schema Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes. number (float) Unique identifier of the node. string Total read operations per second. number (float) avg_write_late ncy optional avg_write_size optional node_id optional read_iops optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values.
Name avg_io_size optional avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average read and write size in bytes. number (float) Average read and write operations per second. number (float) Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes. number (float) Average write operations per second.
Name max_avg_size optional Description Schema Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
Name avg_io_size optional avg_latency optional Description Schema Average read and write size in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes. number (float) Unique identifier of the node. string Total read operations per second.
base_performance_metrics_by_smb_v1_builtin_client_ rollup Summary of smb v1 client level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name avg_calls optional avg_io_size optional avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average calls. number (float) Average read and write size in bytes. number (float) Average read and write operations per second.
Name Description Schema Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second.
base_performance_metrics_by_smb_v1_node Performance metrics for the smb v1 node collected at twenty second interval. Name avg_io_size optional avg_latency optional Description Schema Average read and write size in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
Name write_iops optional Description Schema Total write operations per second. number (float) base_performance_metrics_by_smb_v1_node_rollup Summary of smb v1 node level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Name avg_calls optional avg_io_size optional avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average calls. number (float) Average read and write size in bytes.
Name max_avg_late ncy optional Description Maximum Schema of average read and write latency microseconds. in number (float) max_avg_read _latency Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp optional Time at the beginning of sample period. string (date-time) base_performance_metrics_by_smb_v2_builtin_client Performance metrics for the smb v1 client collected at twenty second interval.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp optional total_calls optional total_iops optional write_iops optional End of sample period. string (date-time) Total calls. number (float) Total read and write operations per second.
Name Description Schema Maximum read latency in microseconds. number (float) Average read size in bytes. number (float) Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes. number (float) avg_read_late ncy optional avg_read_size optional avg_write_iop s optional avg_write_late ncy optional avg_write_size optional max_avg_late ncy optional Maximum of average read and write latency microseconds.
Name max_iops optional Description Schema Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node. string max_read_iop s optional max_write_io ps optional node_id optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values.
Name Description Schema Average write latency in microseconds. number (float) Average write size in bytes. number (float) Unique identifier of the node. string Total read operations per second. number (float) avg_write_late ncy optional avg_write_size optional node_id optional read_iops optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats).
Name avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average read and write operations per second. number (float) Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes. number (float) Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes.
Name Description Schema Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
Name avg_latency optional Description Schema Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes. number (float) Read rate in byte/sec. number (float) Total read operations per second.
Name Description Schema Write rate in byte/sec. number (float) Total write operations per second. number (float) write_bandwi dth optional write_iops optional base_performance_metrics_by_vm Performance metrics for the virtual machine collected at twenty second interval. Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds.
Name timestamp optional Description Schema End of sample period. string (date-time) Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number (float) Unique identifier representing a specific virtual machine. string Write rate in byte/sec. number (float) Total write operations per second.
Name avg_read_size optional Description Schema Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number (float) Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum of average write size in bytes. number (float) Maximum read bandwidth in bytes per second. number (float) Maximum reads per second. number (float) Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum write bandwidth in bytes per second. number (float) Maximum writes per second.
Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. avg_io_size optional avg_latency optional Schema string Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
Name volume_id optional Description Schema Unique identifier representing a specific volume. string Write rate in byte/sec. number (float) Total write operations per second. number (float) write_bandwi dth optional write_iops optional base_performance_metrics_by_volume_rollup Summary of volume level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period.
Name avg_total_iops optional Description Schema Average total input and output operations per second. number Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum read bandwidth in bytes per second. number (float) Maximum reads per second. number (float) Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum write bandwidth in bytes per second. number (float) Maximum writes per second.
base_space_metrics_by_appliance Space metrics for the appliance collected at five minute interval. Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. data_physical _used optional data_reductio n optional Schema string This metric represents amount of physical space user data occupies after deduplication and compression.
Name Description Schema Total physical space consumed in the appliance, accounting physical_used for all efficiency mechanisms, as well as all data protection. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 repeat_count optional Number of times the metrics are repeated.
Name Description last_data_phy Last physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_data_red uction Last data reduction space during the period. number (float) Last efficiency ratio during the period. number (float) optional last_efficiency _ratio optional last_logical_pr Last logical total space during the period.
Name Description Schema Maximum data reduction space during the period. number (float) Maximum efficiency ratio during the period. number (float) max_data_red uction optional max_efficienc y_ratio optional max_logical_p Maxiumum logical total space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Maxiumum logical used space during the period.
base_space_metrics_by_cluster Space metrics for the cluster collected at five minute interval. Name cluster_id optional data_physical _used optional data_reductio n optional Description Schema Identifier of the cluster. string This metric represents total amount of physical space user data occupies after deduplication and compression.
Name Description The physical_used optional total Schema physical space consumed in the cluster, accounting for all efficiency mechanisms, as well as all data protection. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 repeat_count optional shared_logical _used optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 Cluster shared logical used is sum of appliances' shared logical used in the cluster.
Name Description last_data_phy Last physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 Schema integer (int64) last_data_red uction Last data reduction space during the period. number (float) Last efficiency ratio during the period. number (float) optional last_efficiency _ratio optional last_logical_pr Last logical total space during the period.
Name Description Schema Maximum data reduction space during the period. number (float) Maximum efficiency ratio during the period. number (float) max_data_red uction optional max_efficienc y_ratio optional max_logical_p Maximum logical total space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Maximum logical used space during the period.
base_space_metrics_by_storage_container Space metrics of storage container aggregated from all appliances collected at five minute interval. Name logical_provis ioned optional Description Schema Total configured size in bytes of the primary and clone virtual volumes within the storage container. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Amount of data in bytes written to primary and clone logical_used virtual volumes within the storage container.
Name Description Schema last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_snapshot_ savings Last snapshot savings during the period. number (float) optional max_logical_p Maximum logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Maximum logical used space during the period.
Name Description Schema Total amount of data in bytes written to all member logical_used volumes in a volume group. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 repeat_count optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 Total amount of data in bytes host has written to all snap_clone_lo gical_used optional volumes in the volume group without any deduplication, compression or sharing.
Name Description Schema last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_snap_clon Last snap and clone logical used space during the period.
Name timestamp optional vg_id optional Description Schema End of sample period. string (date-time) Unique identifier representing a specific volume group. string base_space_metrics_by_vm Space metrics for the VM collected at five minute interval. Name logical_provis ioned optional Description Schema Total configured size in bytes of all virtual volumes used by virtual machine.
Name Description Schema Ratio of all the vVol provisioned to data they contain. This thin_savings optional is the ratio of logical_provisioned to logical_used. For example, a VM has two 2 GB vVol’s and have written 500 number (float) MB of data to them. The thin savings would be (2 * 2GB) / (2 * 0.5 GB) or 4:1, so the thin_savings value would be 4.0. timestamp optional End of sample period.
Name Description Schema last_unique_p Last unique physical used space during the period. hysical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_p Max logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Max logical used space during the period.
Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. Schema string Configured size in bytes of a volume which amount of data logical_provis can be written to. This metric includes primaries, snaps ioned and clones. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Amount of data in bytes host has written to a volume logical_used optional without any deduplication, compression or sharing.
Name Description Schema Configured size in bytes of a volume which amount of data logical_provis can be written to. This metric includes primaries, snaps ioned and clones. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Amount of data in bytes host has written to a volume logical_used optional family without any deduplication, compression or sharing. This metric includes primaries, snaps and clones.
Name Description Schema Amount of physical space volume family used after unique_physic compression and deduplication. This is the space to be al_used freed up if a volume family is removed from the appliance. integer (int64) optional Minimum value : 0 Maximum value : 9223372036854775807 base_space_metrics_by_volume_family_rollup Space metrics for the volume family for one hour or one day period beginning with timestamp, including the maximum and final values for that period.
Name Description Schema max_logical_p Max logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Max logical used space during the period. sed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_shared_l Max shared logical used space during the period.
Name Description Schema last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_thin_savi ngs Last thin savings ratio during the period. number (float) optional max_logical_p Max logical provisioned space during the period.
Name Description Schema The percentage of drive wear remaining. number (float) percent_endu rance_remain ing optional repeat_count optional timestamp optional Number of times the metrics is repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period.
Name Description Schema Maximum Transmission Unit (MTU) packet size that the mtu bond can transmit, in bytes. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 name Bond name. optional filtering This property supports case-insensitive string chap_config_instance Name id optional Description Schema Unique id of the CHAP config settings instance (always "0").
Name initiator_sessi on_password optional initiator_sessi on_username optional target_discove ry_password optional target_discove ry_username optional target_session _password optional target_session _username optional Description Schema Password used by the initiator to authenticate the target during session authentication. Mutual CHAP mode only. Username used by the initiator to authenticate the target during session authentication. Mutual CHAP mode only.
Name Description Schema Estimate of the lower bound of the 95% confidence interval low_value for the forecast value at the given timestamp. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Estimate for the mean forecast value at the given mean_value timestamp. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 timestamp optional Timestamp when the forecast was performed.
Name Description Schema The id of the appliance acting as master. string The name of the cluster. string master_applia nce_id optional name optional The physical ethernet port (eth_port resource) MTU setting, global for all ports in the cluster.
cluster_time_to_full Name Schema metric_type ForecastMetricTypeEnum required cluster_time_to_full_response Name cluster_id optional end_of_foreca st optional Description Schema Unique ID of the cluster. string Timestamp of the end of the capacity forecast. If time to full estimates are null, the relevant forecast does not reach full capacity before it ends. In this case the end of the forecast can be used as a minimum for time to full.
Name appliance_id optional data_remaini ng optional Description Schema Unique identifier of the appliance. string Number of bytes remaining to be copied at the end of this sampling period. Minimum value : 0 Maximum value : 9223372036854775807 data_transfer Number of bytes transferred during this sampling period.
Name Description Schema The time (in milliseconds) spent in copy activity during this transfer_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Time (in milliseconds) spent doing writes during this write_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 copy_metrics_by_cluster Copy metrics for the cluster.
Name Description Schema session_type CopySessionTypeEn optional um session_type_l 10n Localized message string corresponding to session_type string End of sampling period. string (date-time) optional timestamp optional transfer_rate Data transfer rate (in bytes/second) computed using optional data_transferred and transfer_time. number (float) The time (in milliseconds) spent in copy activity during this transfer_time sampling period.
Name entity_l10n optional Description Schema Localized message string corresponding to entity string Time (in milliseconds) spent doing reads during this read_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 remote_syste m_id Unique identifier of the remote system. string optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values.
copy_metrics_by_vg Cluster wide copy metrics for the volume group. Polymorphism : Inheritance Discriminator : entity Name data_remaini ng optional Description Number of bytes remaining to be copied at the end of this sampling period. Minimum value : 0 Number of bytes transferred during this sampling period.
Name Description transfer_rate Data transfer rate (in bytes/second) computed using optional data_transferred and transfer_time. Schema number (float) The time (in milliseconds) spent in copy activity during this transfer_time sampling period. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 vg_id optional Unique identifier of the volume group. string Time (in milliseconds) spent doing writes during this write_time sampling period.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 session_type CopySessionTypeEn optional um session_type_l 10n Localized message string corresponding to session_type string End of sampling period.
data_connection_instance Data connection status between the local node and a remote target. Name Description Schema Initiating address from the local node. string (ip-address) Unique identifier of the local, initiating node. string initiator_addr ess optional node_id optional status optional status_l10n optional Status of the data connection. TransitConnectionSt atusEnum Localized message string corresponding to status string Target address from the remote system.
Name id optional Description Schema Unique identifier of the DNS setting. string dns_modify Name addresses required Description DNS server addresses in IPv4 or IPv6 format. Schema < string (ip-address) > array email_notify_destination_create Name email_address required notify_critical optional notify_info optional notify_major optional notify_minor optional Description Schema Email address to receive notifications. string Whether to send notifications for critical alerts.
Name notify_info optional notify_major optional notify_minor optional Description Schema Whether to send notifications for informational alerts. boolean Whether to send notifications for major alerts. boolean Whether to send notifications for minor alerts. boolean email_notify_destination_modify Name email_address optional notify_critical optional notify_info optional notify_major optional notify_minor optional Description Schema Email address to receive notifications.
error_message Error message for an operation. Name arguments optional code optional Description Schema Arguments (if applicable) for the error message. < string > array Hexadecimal error code of the message. string message_l10n The message description in the specified locale with optional arguments substituted. string severity MessageSeverityEnu optional m error_response Error response for an operation. Contains an array of localized messages.
eth_port_instance This resource type has queriable associations from ip_port, appliance, hardware, bond, eth_port Name Description appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id optional bond optional The id of the appliance containing the port. Schema appliance_instance string This is the embeddable reference form of bond_id attribute.
Name hypervisor_vs witch_name optional id optional Description Schema Name of the virtual switch associated with the hypervisor port. This property supports case-insensitive filtering Ethernet port instance identifier. string io_module This is the embeddable reference form of io_module_id optional attribute. io_module_id Unique identifier of the hardware instance of type optional 'IO_Module' handling the port.
Name partner_id optional Description Schema Unique identifier of the partner port instance. string port_connecto FrontEndPortConne r_type ctionTypeEnum optional port_connecto r_type_l10n optional port_index optional Localized message string corresponding to port_connector_type string The index of the Ethernet port in IO module.
event_instance An event indicates that something of interest happened in the system. Normally, an event that requires attention will generate an alert as well. So, although they may be interesting for troubleshooting, it is not necessary to monitor events. Name Description Schema Description of this event. string Identifies the specific kind of event that has occurred. string Timestamp at which this event occured. string (date-time) Unique identifier of this occurrence of an event.
Name Description Schema Describes the possible effect on the system of this event. string system_impac t_l10n optional fc_port_instance This resource type has queriable associations from appliance, hardware, fc_port Name Description appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id optional Unique identifier of the appliance containing the port.
Name node optional Description Schema This is the embeddable reference form of node_id attribute. hardware_instance node_id Unique identifier of the hardware instance of type 'Node' optional containing the port. partner This is the embeddable reference form of partner_id optional attribute. partner_id optional Unique identifier of the partner port.
Name supported_sp eeds_l10n optional wwn optional Description Localized Schema message array corresponding to supported_speeds World Wide Name (WWN) of the port. < string > array string fc_port_modify Name Schema requested_speed required FcPortSpeedEnum file_dns_create Name Description Schema Name of the DNS domain, where the NAS Server does host domain names lookup when an FQDN is not specified in the required request.
Name id optional Description Schema Unique identifier of the DNS server. string ip_addresses The list of DNS server IP addresses. The addresses may be < string (ip-address) optional IPv4 or IPv6. nas_server This is the embeddable reference form of nas_server_id optional attribute. nas_server_id optional > array nas_server_instance Unique identifier of the associated NAS Server instance that uses this DNS object. Only one DNS object per NAS Server is string supported.
file_ftp_create Name Description Schema (Applies when the value of is_audit_enabled is true.) audit_dir optional Directory of FTP/SFTP audit files. Logs are saved in '/' directory (default) or in a mounted file system (Absolute string path of the File system directory which should already exist). (Applies when the value of is_audit_enabled is true.) Maximum size of all (current plus archived) FTP/SFTP audit files, in bytes. There is a maximum of 5 audit files, 1 current audit file (ftp.
Name Description Schema Indicates whether the groups attribute contains allowed or is_allowed_gr denied user groups. Values are: - true - groups contains oups allowed user groups. - false - groups contains denied user boolean optional groups. Default : true is_allowed_ho sts optional is_allowed_us ers optional Indicates whether the hosts attribute contains allowed or denied hosts. Values are: true - hosts contains allowed hosts. false - hosts contains denied hosts.
Name Description Indicates is_smb_authe ntication_ena bled optional Schema whether FTP and SFTP clients can be authenticated using an SMB user name. These user names are defined in a Windows domain controller, and their formats are user@domain or domain\user. Values are: - boolean true - SMB user names are accepted for authentication. false - SMB user names are not accepted for authentication.
Name Description Schema (Applies when the value of is_audit_enabled is true.) audit_dir optional Directory of FTP/SFTP audit files. Logs are saved in '/' directory (default) or in a mounted file system (Absolute string path of the File system directory which should already exist). (Applies when the value of is_audit_enabled is true.) Maximum size of all (current plus archived) FTP/SFTP audit files, in bytes. There is a maximum of 5 audit files, 1 current audit file (ftp.log) and 4 archived audit files.
Name Description Schema Indicates whether the groups attribute contains allowed or is_allowed_gr denied user groups. Values are: - true - groups contains oups allowed user groups. - false - groups contains denied user boolean optional groups. Default : true is_allowed_ho sts optional is_allowed_us ers optional Indicates whether the hosts attribute contains allowed or denied hosts. Values are: true - hosts contains allowed hosts. false - hosts contains denied hosts.
Name Description Indicates is_smb_authe ntication_ena bled optional Schema whether FTP and SFTP clients can be authenticated using an SMB user name. These user names are defined in a Windows domain controller, and their formats are user@domain or domain\user. Values are: - boolean true - SMB user names are accepted for authentication. false - SMB user names are not accepted for authentication.
Name Description add_groups Groups to add to the current groups. Error occurs if the optional group already exists. Cannot be combined with groups. add_hosts optional Host IP addresses to add to the current hosts. The addresses may be IPv4 or IPv6. Error occurs if the IP address already exists. Cannot be combined with hosts. add_users Users to add to the current users. Error occurs if the user optional already exist. Cannot be combined with users.
Name Description Schema Allowed or denied hosts, depending on the value of the is_allowed_hosts attribute. A host is defined using its IP address. Subnets using CIDR notation are also supported. hosts optional If allowed hosts exist, only those hosts and no others can connect to the NAS server through FTP or SFTP. - If denied hosts exist, they always have access denied to the NAS < string (ip-address) > array server through FTP or SFTP.
Name Description Schema Indicates whether an FTP or SFTP user access is limited to is_homedir_li the home directory of the user. Values are: - true - An FTP mit_enabled or SFTP user can access only the home directory of the boolean optional user. - false - FTP and SFTP users can access any NAS server directory, according to NAS server permissions. Indicates whether the SFTP server is enabled on the NAS is_sftp_enable server specified in the nasServer attribute.
Name Description Schema Allowed or denied users, depending on the value of the is_allowed_users attribute. - If allowed users exist, only users optional those users and no others can connect to the NAS server through FTP or SFTP. - If denied users exist, they always < string > array have access denied to the NAS server through FTP or SFTP. If the list is empty, there is no restriction to the NAS server access through FTP or SFTP based on the user name.
Name Description Schema Virtual Local Area Network (VLAN) identifier for the interface. The interface uses the identifier to accept packets vlan_id that have matching VLAN tags. optional Default : 0 integer (int32) Minimum value : 0 Maximum value : 4094 file_interface_instance This resource type has queriable associations from nas_server, file_interface_route Name file_interface_ routes optional Description This is the inverse of the resource type file_interface_route association.
Name Description Schema role FileInterfaceRoleEn optional um role_l10n optional Localized message string corresponding to role string Virtual Local Area Network (VLAN) identifier for the interface. The interface uses the identifier to accept packets vlan_id that have matching VLAN tags. optional Default : 0 integer (int32) Minimum value : 0 Maximum value : 4094 file_interface_modify Attributes for the modify operation.
file_interface_route_create Name Description Schema IPv4 or IPv6 address of the target network node based on the specific route type. Values are: destination optional • For a default route, there is no value because the system will use the specified gateway IP address. string (ip-address) • For a host route, the value is the host IP address. • For a subnet route, the value is a subnet IP address. file_interface_ id Unique identifier of the associated file interface.
Name gateway optional Description Schema IP address of the gateway associated with the route. string (ip-address) Unique identifier of the file interface route. string id optional read-only operational_st FileInterfaceRouteO atus perationalStatusEnu optional m operational_st atus_l10n optional prefix_length optional Localized message string corresponding to operational_status string IPv4 or IPv6 prefix length for the route.
Name kdc_addresses required nas_server_id required Description Schema Fully Qualified domain names of the Kerberos Key Distribution Center (KDC) servers. IPv4 and IPv6 addresses < string > array are not supported. Unique identifier of the associated NAS Server instance that uses this Kerberos object. Only one Kerberos object per NAS string Server is supported. KDC servers TCP port.
file_kerberos_keytab_file Name data optional Description Schema The current keytab file for secure NFS service. string (binary) file_kerberos_modify Name Description Schema Fully Qualified domain names of the Kerberos Key add_kdc_addr Distribution Center (KDC) servers to add to the current list. esses Error occurs if name already exists. Cannot be combined < string > array optional with kdc_addresses. IPv4 and IPv6 addresses are not supported.
Name Description Schema authenticatio FileLDAPAuthentica n_type tionTypeEnum required Name of the LDAP base DN. Base Distinguished Name (BDN) of the root of the LDAP directory tree. The appliance uses the DN to bind to the LDAP service and locate in the base_DN required LDAP directory tree to begin a search for information. The base DN can be expressed as a fully-qualified domain name string or in X.509 format by using the attribute dc=. For example, if the fully-qualified domain name is mycompany.
Name Description Schema password The associated password for Kerberos authentication. optional Length : 0 - 1023 string (password) The TCP/IP port used by the NAS Server to connect to the port_number optional LDAP servers. The default port number for LDAP is 389 and LDAPS is 636. integer (int32) Minimum value : 0 Maximum value : 65536 principal Specifies the principal name for Kerberos authentication.
Name Description Schema Name of the LDAP base DN. Base Distinguished Name (BDN) of the root of the LDAP directory tree. The appliance uses the DN to bind to the LDAP service and locate in the base_DN LDAP directory tree to begin a search for information. The optional base DN can be expressed as a fully-qualified domain name string or in X.509 format by using the attribute dc=. For example, if the fully-qualified domain name is mycompany.com, the base DN is expressed as dc=mycompany,dc=com.
Name Description nas_server This is the embeddable reference form of nas_server_id optional attribute. nas_server_id optional Schema nas_server_instance Unique identifier of the associated NAS Server instance that uses this LDAP object. Only one LDAP object per NAS string Server is supported. The TCP/IP port used by the NAS Server to connect to the port_number optional LDAP servers. The default port number for LDAP is 389 and LDAPS is 636.
Name Description Schema addresses The list of LDAP server IP addresses. The addresses may be < string (ip-address) optional IPv4 or IPv6. > array authenticatio FileLDAPAuthentica n_type tionTypeEnum optional Name of the LDAP base DN. Base Distinguished Name (BDN) of the root of the LDAP directory tree. The appliance uses the DN to bind to the LDAP service and locate in the base_DN optional LDAP directory tree to begin a search for information.
Name Description password The associated password for Kerberos authentication. optional Length : 0 - 1023 Schema string (password) The TCP/IP port used by the NAS Server to connect to the port_number LDAP servers. optional Minimum value : 0 integer (int32) Maximum value : 65536 principal Specifies the principal name for Kerberos authentication. optional Length : 0 - 1023 profile_DN optional string For an iPlanet LDAP server, specifies the DN of the entry with the configuration profile.
Name Description Schema Unique identifier of the NDMP service object. string id optional read-only nas_server This is the embeddable reference form of nas_server_id optional attribute. nas_server_id Unique identifier of the NAS server to be configured with optional user_name optional these NDMP settings. User name for accessing the NDMP service.
Name domain optional id optional ip_addresses optional Description Schema Name of the NIS domain. string Unique identifier of the NIS Service. string The list of NIS server IP addresses. nas_server This is the embeddable reference form of nas_server_id optional attribute. nas_server_id optional < string (ip-address) > array nas_server_instance Unique identifier of the associated NAS Server instance that uses this NIS Service object. Only one NIS Service per NAS string Server is supported.
Name Description folder_renam Schema FileSystemFolderRe e_policy namePolicyEnum optional Indicates whether asynchronous MTIME is enabled on the file system. Values are: is_async_MTi me_enabled optional true Asynchronous MTIME is enabled on the file system. boolean false Asynchronous MTIME is disabled on the file system. Indicates whether notifications of changes to directory file structure are enabled. is_smb_no_not true ify_enabled Change directory notifications are enabled.
Name Description Schema Indicates if opportunistic file locking is enabled on the file system. Values are: is_smb_op_loc true ks_enabled Opportunistic file locking is enabled on the file system. optional boolean false Opportunistic file locking is disabled on the file system. Indicates whether the synchronous writes option is enabled on the file system. Values are: is_smb_sync_ writes_enable true d optional Synchronous writes option is enabled on the file system.
Name Description description File system description. (255 UTF-8 characters). optional Length : 0 - 255 folder_renam Schema string FileSystemFolderRe e_policy namePolicyEnum optional Indicates whether asynchronous MTIME is enabled on the file system or protocol snaps that are mounted writeable. Values are: is_async_MTi me_enabled optional true Asynchronous MTIME is enabled on the file system. boolean false Asynchronous MTIME is disabled on the file system.
Name Description Schema Indicates whether file writes notifications are enabled on the file system. Values are: is_smb_notify _on_write_ena bled optional true File writes notifications are enabled on the file system. boolean false File writes notifications are disabled on the file system. Default : false Indicates whether opportunistic file locking is enabled on the file system. Values are: is_smb_op_loc true ks_enabled optional Opportunistic file locking is enabled on the file system.
Name Description Schema Size that the file system presents to the host or end user. size_total (Bytes) required Minimum value : 3221225472 integer (int64) Maximum value : 281474976710656 smb_notify_on Lowest directory level to which the enabled notifications _change_dir_d apply, if any.
Name Description Schema Default hard limit of user quotas and tree quotas (bytes). (0 default_hard_ means 'No limitation'. This value can be used to compute limit the amount of space consumed without limiting the space). integer (int64) optional Minimum value : 0 Maximum value : 9223372036854775807 default_soft_li mit optional description optional Default soft limit of user quotas and tree quotas (bytes).
Name Description Schema Grace period of soft limit (seconds): -1: Infinite grace period (Windows policy). 0: Use default grace period of 1 week grace_period optional (default). positive: Grace period after which the soft limit is treated as a hard limit (seconds). integer (int32) Default : -1 Minimum value : -1 Maximum value : 2147483647 id optional File system id. string Indicates whether asynchronous MTIME is enabled on the file system.
Name Description Schema Indicates whether file access notifications are enabled on the file system. Values are: is_smb_notify _on_access_en true abled optional File access notifications are enabled on the file system. boolean false File access notifications are disabled on the file system. Indicates whether file writes notifications are enabled on the file system. Values are: is_smb_notify _on_write_ena true bled optional File writes notification are enabled on the file system.
Name Description Schema locking_policy FileSystemLockingP optional olicyEnum locking_policy _l10n Localized message string corresponding to locking_policy string optional name File system name. This property supports case-insensitive optional filtering nas_server This is the embeddable reference form of nas_server_id optional attribute. nas_server_id optional Id of the NAS Server on which the file system is mounted.
Name Description Schema smb_notify_on Lowest directory level to which the enabled notifications _change_dir_d apply, if any. epth Minimum value : 0 optional Maximum value : 2147483647 smb_shares This is the inverse of the resource type smb_share optional association. integer (int32) < smb_share_instance > array file_system_modify Name Description Schema access_policy FileSystemAccessPol optional icyEnum Default hard limit of user quotas and tree quotas (bytes).
Name Description Schema Grace period of soft limits (seconds): -1: default: Infinite grace (Windows policy). 0: Use system default of 1 week. grace_period optional positive: Grace period after which the soft limit is treated as a hard limit (seconds). integer (int32) Default : -1 Minimum value : -1 Maximum value : 2147483647 Indicates whether asynchronous MTIME is enabled on the file system or protocol snaps that are mounted writeable.
Name Description Schema Indicates whether file access notifications are enabled on the file system. Values are: is_smb_notify _on_access_en abled optional true File access notifications are enabled on the file system. boolean false File access notifications on file access are disabled on the file system. Indicates whether notifications on file writes are enabled on the file system. Values are: is_smb_notify _on_write_ena true bled optional File writes notifications are enabled on the file system.
Name Description Schema Size, in bytes, presented to the host or end user. This can be size_total used for both expand and shrink on a file system. optional Minimum value : 3221225472 integer (int64) Maximum value : 281474976710656 smb_notify_on Lowest directory level to which the enabled notifications _change_dir_d apply, if any.
Name Description Schema Time, when the snapshot will expire. string (date-time) expiration_ti mestamp optional folder_renam FileSystemFolderRe e_policy namePolicyEnum optional Indicates whether asynchronous MTIME is enabled on the protocol snaps that are mounted writeable. Values are: is_async_MTi me_enabled optional true Asynchronous MTIME is enabled on the file system. boolean false Asynchronous MTIME is disabled on the file system.
Name Description Schema Indicates whether file writes notifications are enabled on the file system. Values are: is_smb_notify _on_write_ena true bled optional File writes notifications are enabled on the file system. boolean false File writes notifications are disabled on the file system. Indicates whether opportunistic file locking is enabled on the file system. Values are: is_smb_op_loc true ks_enabled Opportunistic file locking is enabled on the file system.
Name id optional Description Schema The id of the created snapshot. string file_tree_quota_create Name description optional file_system_id required Description Schema Description of the tree quota. string Unique identifier of the associated file system. string Hard limit of the tree quota, in bytes. No hard limit when set to 0. This value can be used to compute amount of space hard_limit optional that is consumed without limiting the space.
Name description optional Description Schema Description of the tree quota. string file_system This is the embeddable reference form of file_system_id optional attribute. file_system_id optional file_user_tree _quotas optional Unique identifier of the associated file system. This is the inverse of the resource type file_user_quota association. file_system_instance string < file_user_quota_inst ance > array Hard limit of the tree quota, in bytes.
Name Description Schema Soft limit of the tree quota, in bytes. No hard limit when set soft_limit to 0. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 state FileQuotaStateEnum optional state_l10n optional Localized message string corresponding to state string file_tree_quota_modify Name description optional Description Schema Description of the tree quota. string Hard limit of the tree quota, in bytes. No hard limit when set to 0.
Name Description file_system_id Unique identifier of the filesystem in which the new user required quota will be created. Schema string Hard limit of the user quota, in bytes. No hard limit when set to 0. This value can be used to compute amount of space hard_limit optional that is consumed without limiting the space. Value is rounded up to match the physical block size of the integer (int64) filesystem. Minimum value : 0 Maximum value : 9223372036854775807 Soft limit of the user quota, in bytes.
Name Description file_system This is the embeddable reference form of file_system_id optional attribute. file_system_id optional Unique identifier of the associated filesystem. Schema file_system_instance string Hard limit of the user quota, in bytes. No hard limit when hard_limit optional set to 0. This value can be used to compute amount of space that is consumed without limiting the space.
Name Description Schema Unique identifier of the associated tree quota. Values are: tree_quota_id null - if the user quota is not within a quota tree. - optional tree_quota instance id - if the user quota is within a quota string tree. uid optional unix_name optional windows_nam e optional windows_sid optional Unix user identifier (UID) of the user. Minimum value : 1 integer (int64) Maximum value : 4294967294 Unix username. Windows username. The format is domain\user for the domain user.
Name nas_server_id required Description Schema Unique identifier of an associated NAS Server instance that uses this virus checker configuration. Only one virus string checker configuration per NAS Server is supported. file_virus_checker_instance This resource type has queriable association from nas_server Name id optional Description Schema Unique identifier of the virus checker instance. string is_config_file_ Indicates whether a virus checker configuration file has uploaded been uploaded.
Name Description Schema Indicates whether the anti-virus service is enabled on this NAS server. Value are: - true - Anti-virus service is enabled. Each file created or modified by an SMB client is scanned by the third-party anti-virus servers. If a virus is detected, is_enabled the access to the file system is denied. If third-party anti- required virus servers are not available, according the policy, the boolean access to the file systems is denied to prevent potential viruses propagation.
Name Description Schema Total number of physical cores. Available on the Node cpu_cores hardware type. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 cpu_model optional CPU model name. Available on Node hardware type. string Total number of physical sockets. Available on the Node cpu_sockets hardware type. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 dell_service_t ag optional Dell service tag of the hardware.
Name Description Schema Localized message string corresponding to fips_status string fips_status_l10 n optional firmware_ver sion optional Firmware version of the hardware. Available on the Drive hardware type. string mode HardwareSFPModeE optional num mode_l10n optional Localized message string corresponding to mode string model_name Model name of the hardware. Available on the IO_Module optional and M2_Drive hardware types.
hardware_instance Hardware component information. This resource type has queriable associations from fc_port, sas_port, eth_port, hardware, appliance Name Description appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id optional The id of the component’s associated appliance. Schema appliance_instance string < children This is the inverse of the resource type hardware optional association. extra_details Additional hardware details.
Name Description name The name of the component. This property supports case- optional insensitive filtering node_eth_port s This is the inverse of the resource type eth_port association. optional node_fc_ports optional This is the inverse of the resource type fc_port association. node_sas_port s This is the inverse of the resource type sas_port association. optional parent This is the embeddable reference form of parent_id optional attribute.
Name Description Schema Localized message string corresponding to status_led_state string status_led_sta te_l10n optional type optional type_l10n optional HardwareTypeEnu Hardware component type. m Localized message string corresponding to type string hardware_modify Hardware properties to modify. Name Description Schema New state for the hardware component location marker LED. Setting it to true will put the LED in a blinking state until set to false.
host_create Name Description Schema An optional description for the host. The description should description not be more than 256 UTF-8 characters long and should not optional have any unprintable characters. string Maximal length : 256 < initiators initiator_create_mod required ify > array The host name. The name should not be more than 128 name UTF-8 characters long and should not have any unprintable required characters.
host_group_create Create host group parameters. Name Description description optional Schema An optional description for the host group. The description should not have any unprintable characters. string Maximal length : 256 host_ids < string > array required The host group name. The name should not be more than name 128 UTF-8 characters long and should not have any required unprintable characters.
Name mapped_host_ groups optional Description This is Schema the inverse of the resource type host_volume_mapping association. name The host group name. This property supports case- optional insensitive filtering < host_volume_mappi ng_instance > array string host_group_modify Modify host group parameters. Name Description add_host_ids List of hosts to be added to host group. The operation fails if optional the host(s) to be added are attached to volume.
Name chap_single_u sername optional port_name optional Description Schema Username for CHAP authentication. This value must be 1 to 64 UTF-8 characters. CHAP username is required when the cluster CHAP mode is mutual authentication. string Length : 1 - 64 IQN name aka address.
Name import_host_s ystem optional Description This is Schema the embeddable reference form of import_host_system_ import_host_system_id attribute. mapped_hosts This is the inverse of instance the resource type optional host_volume_mapping association. name The host name.
host_virtual_volume_mapping_instance Virtual volume mapping details. This resource type has queriable associations from host, host_group, virtual_volume Name host optional Description Schema This is the embeddable reference form of host_id attribute. host_instance host_group This is the embeddable reference form of host_group_id optional attribute. host_group_id Unique identifier of a host group attached to a virtual optional volume. The host_id and host_group_id cannot both be set.
Name Description host_group_id Unique identifier of a host group attached to a volume. The optional host_id and host_group_id cannot both be set. host_id Unique identifier of a host attached to a volume. The optional host_id and host_group_id cannot both be set. id Unique identifier of a mapping between a host and a optional volume. Schema string string string logical_unit_n Logical unit number for the host volume access.
import_host_system_create Required parameters for adding an import host system. Name agent_address required agent_port required Description Schema Hostname or IPv4 address of the import host system. string TCP port of the import host system. Minimum value : 0 integer (int32) Maximum value : 65535 chap_mutual_ Password for mutual CHAP authentication. This password password is required when the cluster is using mutual authentication string (password) optional CHAP mode.
Name agent_address optional Description Schema Hostname or IPv4 address of the import host system. string (ip-address) API version of the import host system. string agent_api_ver sion optional agent_port optional TCP port on the import host system.
Name os_version optional user_name optional Description Schema Operating system version of the import host system. string Username for the import host system. string import_host_volume_instance Details about an import host volume. Name active_path optional Description Schema Active path of the host volume. ActivePathEnum Localized message string corresponding to active_path string Unique identifier of the storage system. string Product type of the storage system.
Name is_migrating optional Description Schema Indicates whether the import host volume is migrating. boolean Time when the import host volume was last updated. string (date-time) Mount paths on the import host system. < string > array last_update_ti me optional mount_paths optional naa_id Unique identifier of a volume that is presented to the optional import host. name Name of the import host volume.
Name group_addres s optional id optional import_psgro up_volumes optional Description Schema IP address of the PS Group, which is used for data path communication. If a management address is not configured, this address is also used for management string (ip-address) operations. Unique identifier of the PS Group. string < This is the inverse of the resource type import_psgroup_vol import_psgroup_volume association.
Name end_time optional frequency optional Description Schema Time when snapshot creation ends each day, in minutes. Minimum value : 0 integer (int32) Maximum value : 2147483647 Frequency at which snapshots are created, in minutes. Minimum value : 0 integer (int32) Maximum value : 2147483647 Number of days for which the snapshot schedule has been inactive_date inactive.
import_psgroup_volume_import_snapshot_schedules_ response Type : < import_psgroup_schedule_instance > array import_psgroup_volume_instance PS Group volume instance details.
Name is_read_only optional Description Schema Indicates whether the volume is read-only. boolean migration_sta te ImportStatusEnum optional migration_sta te_l10n Localized message string corresponding to migration_state string optional name Name of the volume. This property supports case- optional insensitive filtering size optional wwn optional string Size of the volume, in bytes. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Unique WWN of the volume.
Name Description Schema Name of the import session. The name must be unique in name required the PowerStore cluster and can contain a maximum of 128 unicode characters. It cannot contain special HTTP string characters, unprintable characters, or white space. Maximal length : 128 Unique identifier of the protection policy that will be protection_po licy_id optional applied to an imported volume or consistency group after the import completes. Only snapshot policies are supported in an import.
Name Description Schema automatic_cut Indicates whether the import session cutover is manual over (true) or automatic (false). optional Default : false boolean Average transfer rate of a data import operation in average_trans bytes/sec over the whole copy period. Before and after the fer_rate import is in the Copy_In_Progress state, this value is null.
Name last_update_ti mestamp optional Description Date and time when was the import was last updated. This value is updated each time the import job updates. Schema string (date-time) name User-specified name of the import session. This property optional supports case-insensitive filtering parent_sessio For a volume that is part of a consistency group import, this n_id value is the session identifier of the import session. For an string optional individual volume import, this value is null.
Name state_l10n optional volume_group _id optional Description Schema Localized message string corresponding to state string Unique identifier of the volume group to which the destination volume will be added, if any. string import_session_modify Name Description Schema scheduled_tim Indicates the new date and time at which the import estamp session is scheduled to run. The date is specified in ISO string (date-time) optional 8601 format with time expressed in UTC format.
Name Description importable_cr iteria optional importable_cr iteria_l10n optional Schema Volume import criteria. If the value is not Ready, the CGImportableCriteri volume is not importable. Localized message aEnum string corresponding to importable_criteria name Name of the SC consistency group.
Name Description Schema management_ Management address to use for communicating with the SC address array. The address can be an IPv4 address, IPv6 address, or string (ip-address) optional FQDN (Fully Qualified Domain Name). model optional Model name of the SC array. name Name of the SC array. This property supports case- optional insensitive filtering serial_numbe Serial number of the SC array.
Name Description type optional type_l10n optional Schema ScSnapshotProfileTy Type of the snapshot profile.
Name Description Schema import_storag e_center_cons Unique identifier of an SC consistency group, if the volume istency_group is part of one consistency group only. If the volume is part string _id of multiple consistency groups, the attribute is empty. optional import_storag e_center_cons istency_group _names Names of the consistency groups of which the volume is a member, if this volume is in multiple consistency groups.
Name Description Schema wwn Device identifier presented to the server to which the optional volume is mapped. string import_unity_consistency_group_import_snapshot_sch edules_response Type : < import_unity_snapshot_schedule_instance > array import_unity_consistency_group_instance This resource type has queriable associations from import_unity_volume, import_unity Name id optional Description Schema Unique identifier of the Unity consistency group.
Name api_version optional Description Schema Version of the API that the Unity storage system supports. string health UnityHealthEnum optional health_l10n optional id optional Localized message string corresponding to health string Unique identifier of the Unity storage system that is a source storage system for import. This is the serial number string of the storage system. import_unity_ < consistency_g This roups import_unity_consistency_group association.
Name Description Schema Software version of the Unity storage system. string software_vers ion optional user_name User account name used to communicate with the Unity optional storage system. string import_unity_snapshot_schedule_instance Name id optional Description Schema Unique identifier of the Unity snapshot schedule. string is_default Indicates whether the Unity snapshot schedule is the optional default snapshot schedule.
Name Description days_of_week Days of the week for which the snapshot schedule rule optional applies. Schema < UnityDayofWeekEn um > array days_of_week_ l10n Localized message array corresponding to days_of_week < string > array Hourly frequency for the snapshot schedule rule.[0..23]. < integer > array Unique identifier of the snapshot schedule rule . string optional hours optional id optional Number of days or hours between snaps, depending on the interval rule type. [1..31].
import_unity_volume_instance This resource type has queriable associations from import_unity, import_unity_consistency_group Name Description Schema health UnityHealthEnum optional health_l10n optional host_volume_i ds optional id optional Localized message string corresponding to health string List of host volume identifiers that correspond to Unity volumes. Unique identifier of the Unity volume.
Name Description is_replication _destination optional is_thin_clone optional Schema Indicates whether the Unity volume is a replication destination. Indicates whether the Unity volume is a thin clone. boolean boolean migration_sta UnityVolumeMigrati te onStateEnum optional migration_sta te_l10n Localized message string corresponding to migration_state string optional name Name of the Unity volume.
Name id optional Description Schema Unique identifier of the VNX storage system. string import_vnx_c < onsistency_gr This oups import_vnx_consistency_group association. is the inverse of the resource type import_vnx_consiste optional import_vnx_v olumes optional is_faulted optional ncy_group_instance > array This is the inverse of the resource type import_vnx_volume association. Indicates whether the VNX storage system is faulted.
import_vnx_consistency_group_instance This resource type has queriable associations from import_vnx_volume, import_vnx_array Name id optional import_vnx_a rray Description Schema Unique identifier of the VNX consistency group. string This is the embeddable reference form of import_vnx_array_i import_vnx_array_id attribute. optional import_vnx_a rray_id nstance Unique identifier of the VNX storage system where the consistency group exists.
Name host_volume_i ds optional id optional import_vnx_a rray optional import_vnx_a rray_id optional Description Schema List of host volume identifiers associated with the VNX volume. Unique identifier of the VNX volume. This is the embeddable < string > array string reference form of import_vnx_array_i import_vnx_array_id attribute. nstance Unique identifier of the VNX storage system where the volume exists.
Name size optional wwn optional Description Schema Size of the VNX volume in bytes. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 World wide name of the VNX volume. string initiator_create_modify Name Description Schema Password for CHAP authentication. This value must be 12 chap_mutual_ to 64 UTF-8 characters. This password is not queriable. password CHAP password is required when the cluster CHAP mode is string (password) optional mutual authentication.
Name address optional Description Schema IP address value, in IPv4 or IPv6 format. string (ip-address) appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id Unique identifier of the appliance to which the IP address optional belongs. id optional Unique identifier of the IP address. ip_port This is the embeddable reference form of ip_port_id optional attribute.
Name Description available_usa ges Available IP port usages. optional Schema < IpPortUsageEnum > array available_usa ges_l10n Localized message array corresponding to available_usages < string > array optional bond optional bond_id optional This is the embeddable reference form of bond_id attribute. bond_instance Unique identifier of the bond on top of which the IP port is configured. If the IP port is configured on top of an string Ethernet front-end port, this attribute should be empty.
Name Description Schema Identifier of the IP port that is configured on top of physical partner_id optional Ethernet port or virtual Ethernet port or bond with the same physical location on the other node of the appliance. string Partner ports are configured symmetrically for HA and load balancing purposes within the appliance. iSCSI qualified name used by the target configured on top target_iqn of the IP port initially or as a result of network scaling.
job_appliance_forecast_response Polymorphism : Inheritance Discriminator : response_type Name Description Schema Estimate for the upper bound forecasted value on that high_value particular time. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Estimate for the lower bound forecasted value on that low_value particular time.
Name Description time_to_full Estimated date-time at which the forecast value will reach optional full capacity. time_to_full_o ptimistic optional time_to_full_p essimistic optional Schema Optimistic date-time for time to full based on the lower bound of the forecast 95% confidence interval. Pessimistic date-time for time to full based on the upper bound of the forecast 95% confidence interval.
Name timestamp optional Description Schema Timestamp when the forecast was performed. string (date-time) job_cluster_time_to_full_response Polymorphism : Inheritance Discriminator : response_type Name cluster_id optional end_of_foreca st optional Description Schema Unique ID of the cluster. string Timestamp of the end of the capacity forecast. If time to full estimates are null, the relevant forecast does not reach full capacity before it ends.
Polymorphism : Inheritance Discriminator : response_type Name id optional Description Schema Unique identifier of the new instance created. string response_type string required job_error_response Error response for an operation. Contains an array of localized messages. Polymorphism : Inheritance Discriminator : response_type Name Schema messages < error_message > array optional response_type string required job_file_system_clone_response File system clone created.
Discriminator : response_type Name id optional Description Schema The id of the created snapshot. string response_type string required job_file_system_snapshot_response Snapshot file system created. Polymorphism : Inheritance Discriminator : response_type Name id optional Description Schema The id of the created snapshot. string response_type string required job_instance Information about the job.
Name id optional leafs optional Description Schema Unique identifier of the job. string This is the inverse of the resource type job association. parent This is the embeddable reference form of parent_id optional attribute. parent_id optional Unique identifier of the parent job, if applicable. < job_instance > array job_instance string progress_perc Percent complete of the job.
Name root optional Description Schema This is the embeddable reference form of root_id attribute. job_instance root_id Unique identifier of the root job, if applicable. The root job optional is the job at the top of the parent hierarchy. start_time optional Date and time when the job execution started.
Discriminator : response_type Name download_uri optional Description Schema A Uniform Resource Identifier which can be used in a subsequent GET request to download the keystore backup string archive file. response_type string required job_migration_recommendation_create_migration_ses sions_response Polymorphism : Inheritance Discriminator : response_type Name Description Schema ID of migration sessions created for the recommendation.
Name Description Schema response_type string required job_response Job response for an asynchronous request. The response to any asynchronous request that does not fail immediately. Name id optional Description Schema The id of the job created by the request. string job_virtual_machine_snapshot_response The response to a virtual_machine snapshot request. Polymorphism : Inheritance Discriminator : response_type Name id optional Description Schema Unique id of the new snapshot.
job_volume_group_clone_response Response for volume group clone action Polymorphism : Inheritance Discriminator : response_type Name id optional Description Schema Unique identifier of the new instance created. string response_type string required job_volume_group_refresh_response volume group refresh response. Polymorphism : Inheritance Discriminator : response_type Name Description Schema backup_snaps Unique identifier of the backup snapshot set.
job_volume_group_snapshot_response Unique identifier of the new snapshot volume. Polymorphism : Inheritance Discriminator : response_type Name id optional response_type required Schema string string job_volume_refresh_response Unique identifier of the backup snapshot if one is created.
job_volume_snapshot_response Unique identifier of the new snapshot volume. Polymorphism : Inheritance Discriminator : response_type Name Schema id string optional response_type string required job_vvol_error_response Polymorphism : Inheritance Discriminator : response_type Name Description description Schema string optional error_code Minimum value : 0 optional Maximum value : 2147483647 response_type integer (int32) string required keystore_archive_instance A keystore archive file.
Name download_uri optional Description Schema A Uniform Resource Identifier which can be used in a subsequent GET request to download the keystore backup string archive file. license_instance Software license information for the cluster. Name Description Schema activation_file The content of the license activation file to send to the _content DellEMC Software Licensing Central to retrieve the string optional software license for the cluster.
Name Description Schema The unique identifier of the role to which the new local role_id required user will be mapped. Where role_id "1" is for Administrator, "2" is for Storage Administrator, "3" is for string Operator, "4" is for VM Administrator and "5" is for Security Administrator roles. local_user_instance Information about a local user. Name id optional is_built_in optional is_default_pas sword optional Description Schema Unique identifier of the local user account.
Name Description Schema New password of the local user. Local user with password optional administrator or security administrator role can reset the password of other local user accounts without providing string (password) the current password. You cannot reset the password of the account you are currently logged-in to. The unique identifier of the new role to which the local user has to be mapped.
Name id optional Description Schema Unique identifier of the login session. string Remaining idle time until the session will expire, in idle_timeout seconds. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 is_built_in_us er Indicates whether the logged-in user is predefined. boolean optional is_password_c hange_requir Indicates whether the logged-in user requires a password ed change.
maintenance_window_modify Name Description Schema Number of seconds from the current timestamp the maintenance window will expire. This value is required if end_offset is_enabled is passed as true, and may not be more than optional 172800 (48 hours). integer (int32) Minimum value : 0 Maximum value : 172800 is_enabled optional Activate or deactivate the window for one appliance. boolean member_certificate_instance Embedded member certificate in x509_certificate.
Name Description Schema Certificate signature algorithm. string Certificate subject or so called distinguished name. string signature_alg orithm optional subject optional subject_altern ative_names optional thumbprint optional Additional DNS names or IP addresses in the x509_certificate. Hash value of the certificate.
metrics_generate_response Response will be just an array of one of the child of this definition Name Description entity MetricsEntityEnum required entity_l10n optional Schema Localized message string corresponding to entity string migration_recommendation_action A recommended migration action.
Name Description Schema migration_pri mary_resourc Localized e_type_l10n message string corresponding to migration_primary_resource_type string optional migration_rea MigrationRecomme son ndationReasonEnum required migration_rea son_l10n optional primary_id required Localized message string corresponding to migration_reason string Unique ID of the primary object. string Name of the primary object. string ID of storage resource migrated by this action.
Name Description Schema Evacuate appliance by specifying optional space_to_free evacuate_appliance evacuate_appl iance required evacuate_appliance Name Description Schema appliance_id ID of appliance on which available space is desired. required Example : "evac_from_appliance" string Optional desired amount of used storage (in bytes) to move to other appliances.
migration_recommendation_instance Name Description Schema Time at which recommendation was created. string (date-time) created_times tamp optional Unitless value describing estimated cost to migrate all estimated_cos volumes for this recommendation relative to other t recommendations. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 id optional migration_act ions optional Unique ID of recommendation.
Name Description Type of Schema request that generated a migration type recommendation. Evacuate_Appliance - A recommendation MigrationRecomme optional to evacuate space by auto selecting storage objects from an ndationTypeEnum appliance using specified size. type_l10n optional Localized message string corresponding to type string migration_session_create Name automatic_cut over optional Description Schema Indicates whether the migration session cutover is manual or automatic.
Name id optional rescan_host_i ds optional Description Schema Identifier of the migration_session object. string List of hosts that be rescanned before a migration session can proceed. < string > array migration_session_delete Name force optional Description Schema Indicates whether all migration activities will be canceled before deleting the session. boolean Default : false migration_session_instance A migration session.
Name Description Schema Family identifier designating the storage resource or resources being migrated. For volume or virtual_volume family_id optional migrations, the family is moved together because they share data among the primary object, snapshots, and string clones. For volume_group migration, the family of each volume in the group is moved because it is a grouping of volumes. id optional Unique identifier of the migration session instance. string Time of the last successful sync operation.
Name virtual_volum es optional volume_group s optional volumes optional Description This is the inverse of the resource type virtual_volume association. This is the inverse of the resource type volume_group association. This is the inverse of the resource type volume association.
Name default_windo ws_user optional Description Schema Default Windows user name used for granting access in case of Unix to Windows user mapping failure. When empty, access in such case is denied. string Length : 0 - 1023 description Description of the NAS server. optional Length : 0 - 255 string A Windows user must have a corresponding matching Unix is_auto_user_ mapping_ena bled optional user (uid) in order to connect.
Name Description Schema Indicates whether to keep the associated SMB servers joined to the Active Directory when the NAS server is is_skip_domai n_unjoin optional deleted. Values are:\n - true - Keep the associated SMB servers joined to the Active Directory when the NAS server is deleted. - false - (Default) Try to unjoin the associated boolean SMB servers from the Active Directory before deleting the NAS server.
Name Description Schema current_unix_ directory_ser Localized vice_l10n current_unix_directory_service message string corresponding to string optional default_unix_ Default Unix user name used for granting access in case of user Windows to Unix user mapping failure. When empty, string optional access in such case is denied. default_windo Default Windows user name used for granting access in ws_user case of Unix to Windows user mapping failure.
Name file_virus_che ckers optional id optional Description Schema This is the inverse of the resource type file_virus_checker association. < file_virus_checker_i nstance > array Unique identifier of the NAS server. string A Windows user must have a corresponding matching Unix is_auto_user_ mapping_ena bled optional user (uid) in order to connect.
Name Description Schema production_IP v6_interface_i Unique d identifier of the preferred IPv6 production interface. string optional smb_servers This is the inverse of the resource type smb_server optional association. < smb_server_instance > array nas_server_modify Arguments for the modify operation. Name Description Schema Unique identifier of the preferred IPv4 backup interface. string Unique identifier of the preferred IPv6 backup interface.
Name Description Schema A Windows user must have a corresponding matching Unix is_auto_user_ mapping_ena bled optional user (uid) in order to connect. This attribute enables you to automatically generate this Unix user (uid), if that Windows user does not have any in the configured Unix boolean directory service (UDS). In a pure SMB or non multiprotocol environment, this should be set to true.
network_instance This resource type has queriable association from ip_pool_address Name Description gateway Network gateway in IPv4 or IPv6 format, corresponding to optional the network’s IP version. id optional ip_pool_addre sses optional Unique identifier of the network. This is the inverse of the resource type ip_pool_address association.
Name Description Schema add_addresse s < string (ip-address) IP addresses to add in IPv4 or IPv6 format. > array optional New cluster management IP address in IPv4 or IPv6 format, cluster_mgmt _address optional corresponding to the network’s IP version. This can only be specified when reconfiguring the management network. string (ip-address) Caution: Changing the cluster management IP address will lead to losing management sessions through this address.
Name prefix_length optional Description Schema Network prefix length. (Used for both IPv4 and IPv6). Minimum value : 1 integer (int32) Maximum value : 127 remove_addre sses < string (ip-address) IP addresses to remove in IPv4 or IPv6 format. > array optional storage_disco very_address optional vasa_provider _credentials optional vlan_id optional New storage discovery IP address in IPv4 or IPv6 format, corresponding to the network’s IP version.
Name Description Schema esxi_credenti als esxi_credentials optional Indicates whether to suppress network validation errors. The option is intended to suppress false errors caused by network environment constraints.
Name prefix_length required Description Schema Network prefix length. (Used for both IPv4 and IPv6). Minimum value : 1 integer (int32) Maximum value : 127 smtp_config network_replace_sm optional tp_config vasa_provider _credentials optional Credentials required for re-registering the VASA vendor provider during the replacement of the cluster vasa_provider_crede management IP address. Should be passed only when ntials reconfiguring PowerStoreX cluster.
Name Description Schema purpose PhysicalSwitchPurp optional oseEnum network_replace_physical_switch_connection Name Description address Physical switch address in IPv4 or IPv6 or DNS hostname required format. connect_meth ectMethodEnum required optional snmp_commu nity_string optional string (ip-address) PhysicalSwitchConn od port Schema Port used for connection to switch.
network_scale Name Description add_port_ids Unique identifiers of available IP ports to be used in the optional network. Schema < string > array Indicates whether to suppress network validation errors. The option is intended to suppress false errors caused by network environment constraints.
Name Description Schema default_access NFSExportDefaultAc optional cessEnum description User defined NFS Export description. optional Length : 0 - 511 string file_system_id Unique identifier of the file system on which the NFS required is_no_SUID optional Export will be created. string If set, do not allow access to set SUID. Otherwise, allow boolean access. Default : false min_security NFSExportMinSecur optional ityEnum name NFS Export name.
Name Description Schema Hosts with read-only and ready-only for root user access to read_only_roo the NFS Export and its snapshots. Hosts can be entered by t_hosts Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, < string > array optional IPv6/PrefixLenght, or IPv4/subnetmask), or Netgroups prefixed with @. read_write_ho sts optional Hosts with read and write access to the NFS export and its snapshots.
Name Description Schema file_system This is the embeddable reference form of file_system_id optional attribute. file_system_id Unique identifier of the file system on which the NFS optional id optional Export was created. Unique id of the NFS Export. file_system_instance string string is_no_SUID If set, do not allow access to set SUID. Otherwise, allow optional access.
Name read_only_hos ts optional Description Schema Hosts with read-only access to the NFS export and its snapshots. Hosts can be entered by Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or < string > array IPv4/subnetmask), or Netgroups prefixed with @. Hosts with read-only and ready-only for root user access to read_only_roo the NFS Export and its snapshots.
Name Description Schema Hosts to add to the current read_write_hosts list. Hosts can add_read_writ be entered by Hostname, IP addresses (IPv4, IPv6, e_hosts IPv4/PrefixLength, IPv6/PrefixLenght, or IPv4/subnetmask), < string > array optional or Netgroups prefixed with @. Error if Host is already exists. Cannot combine with read_write_hosts. Hosts to add to the current read_write_root_hosts list.
Name Description Schema Hosts with read-only and ready-only for root user access to read_only_roo the NFS Export and its snapshots. Hosts can be entered by t_hosts Hostname, IP addresses (IPv4, IPv6, IPv4/PrefixLength, < string > array optional IPv6/PrefixLenght, or IPv4/subnetmask), Netgroups prefixed with @. read_write_ho sts optional Hosts with read and write access to the NFS export and its snapshots.
Name Description Schema Hosts to remove from the current read_write_root_hosts remove_read_ list. Hosts can be entered by Hostname, IP addresses (IPv4, write_root_ho IPv6, IPv4/PrefixLength, IPv6/PrefixLenght, or sts IPv4/subnetmask), or Netgroups prefixed with @. Error if optional the host is not present. Cannot combine < string > array with read_write_root_hosts. nfs_server_create Argument for the NFS server create operation.
Name Description Schema Indicates whether NFSv3 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv3. is_nfsv3_enabl When disabled, NFS shares can not be accessed with NFSv3 ed protocol. - true - NFSv3 is enabled on the specified NAS boolean optional server. - false - NFSv3 is disabled on the specified NAS server. Default : true Indicates whether NFSv4 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv4.
nfs_server_instance This resource type has queriable association from nas_server Name Description Schema Sets the Time-To-Live (in minutes) expiration timestamp for a Windows entry in the credentials cache. When failed credentials_ca mapping entries expire, the system retries mapping the UID che_TTL to the SID. optional Default : 5 integer (int32) Minimum value : 0 Maximum value : 2147483647 The name that will be used by NFS clients to connect to this host_name optional NFS server.
Name Description Schema Indicates whether NFSv4 is enabled on the NAS server. is_nfsv4_enabl ed optional When enabled, NFS shares can be accessed with NFSv4. When disabled, NFS shares cannot be accessed with NFSv4 protocol. - true - NFSv4 is enabled on the specified NAS boolean server. - false - NFSv4 is disabled on the specified NAS server. is_secure_ena Indicates whether secure NFS is enabled on the NFS server. bled - true - Secure NFS is Enabled.
nfs_server_modify Arguments for the NFS server modify operation. Name Description Schema Sets the Time-To-Live (in minutes) expiration stamp for a Windows entry in the credentials cache. When failed credentials_ca mapping entries expire, the system retries mapping the UID che_TTL to the SID. optional Default : 5 integer (int32) Minimum value : 0 Maximum value : 2147483647 The name that will be used by NFS clients to connect to this NFS server.
Name Description Schema is_secure_ena Indicates whether secure NFS is enabled on the NFS server. bled - true - Secure NFS is Enabled. - false - Secure NFS is boolean optional disabled. Allow to bypass NFS server unjoin. If false modification will is_skip_unjoin fail if secure is enabled and current kdc_type is MS optional Windows. If secure is enabled either unjoin NFS server boolean before deleting or set value to true.
Name id optional ip_pool_addre sses optional slot optional Description Schema Unique identifier of the node. string This is the inverse of the resource type ip_pool_address association. < ip_pool_address_inst ance > array Slot number of the node. Minimum value : 0 integer (int32) Maximum value : 2147483647 veth_ports This is the inverse of the resource type veth_port < veth_port_instance optional association. > array ntp_instance Name Description addresses NTP server addresses.
Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
Name Description Schema Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number Write rate in bytes per second. number (float) Total write operations per second.
Name Description Schema Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) max_avg_read _latency optional max_avg_read _size optional max_avg_writ e_latency optional max_avg_writ e_size optional max_io_workl The maximum percentage of CPU Utilization on the cores oad_cpu_utiliz dedicated to servicing storage I/O requests.
Name repeat_count optional timestamp optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) performance_metrics_by_cluster Performance metrics for the cluster collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes.
Name Description Schema Read rate in bytes per second. number (float) Total number of read operations per second. number (float) read_bandwid th optional read_iops optional repeat_count optional timestamp optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) Total data transfer rate in bytes per second. number (float) Total read and write operations per second.
Name Description Schema Weighted average read bandwidth in bytes per second. number (float) Average reads per second. number (float) Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number Weighted average write bandwidth in bytes per second. number (float) Average writes per second.
Name entity_l10n optional max_avg_io_si ze optional Description Schema Localized message string corresponding to entity string Maximum average size of input and output operations in bytes. number (float) max_avg_late ncy Maximum of average latency in microseconds. number (float) Maximum read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes.
Name Description Schema Maximum write bandwidth in bytes per second. number (float) Maximum writes per second. number (float) max_write_ba ndwidth optional max_write_io ps optional repeat_count optional timestamp optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) performance_metrics_by_fe_eth_node Ethernet performance metrics for the node collected at twenty second interval.
Name pkt_rx_crc_er ror_ps optional pkt_rx_no_buf fer_error_ps optional pkt_rx_ps optional pkt_tx_error_ ps optional pkt_tx_ps optional repeat_count optional timestamp optional Description The number of packets received with CRC error (and thus dropped) per second. The number of packets discarded per second due to lack of buffer space. The number of packets received per second. The number of packets that failed to be transmitted per second due to error. The number of packets transmitted per second.
Name avg_pkt_rx_cr c_error_ps optional Description The average number of packets received with CRC error (and thus dropped) per second. Schema number (float) avg_pkt_rx_no _buffer_error_ The average number of packets discarded per second due ps to lack of buffer space. number (float) optional avg_pkt_rx_ps optional avg_pkt_tx_er ror_ps optional avg_pkt_tx_ps optional The average number of packets received per second.
Name Description Schema The maximum number of packets received per second. number (float) max_pkt_rx_p s optional max_pkt_tx_e rror_ps optional The maximum number of packets that failed to be transmitted per second due to error. number (float) max_pkt_tx_p s The maximum number of packets transmitted per second. number (float) optional node_id Reference to the associated node on which these metrics optional were recorded.
Name entity_l10n optional Description Schema Localized message string corresponding to entity string fe_port_id Reference optional (eth_port) on which these metrics were recorded. node_id optional pkt_rx_crc_er ror_ps optional pkt_rx_no_buf fer_error_ps optional pkt_rx_ps optional pkt_tx_error_ ps optional pkt_tx_ps optional repeat_count optional timestamp optional to the associated frontend ethernet port Reference to the node the port belongs to.
Name Description Schema appliance_id Reference to the associated appliance on which these optional metrics were recorded. string avg_bytes_rx_ ps The average total bytes received per second. number (float) The average total bytes transmitted per second. number (float) optional avg_bytes_tx_ ps optional avg_pkt_rx_cr c_error_ps optional The average number of packets received with CRC error (and thus dropped) per second.
Name Description Schema The maximum total bytes transmitted per second. number (float) max_bytes_tx_ ps optional max_pkt_rx_c rc_error_ps optional The maximum number of packets received with CRC error (and thus dropped) per second. number (float) max_pkt_rx_n o_buffer_erro The maximum number of packets discarded per second r_ps due to lack of buffer space. number (float) optional max_pkt_rx_p s The maximum number of packets received per second.
Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
Name Description Schema Link failure count per second. number (float) Loss of signal count per second. number (float) Loss of sync count per second. number (float) link_failure_c ount_ps optional loss_of_signal _count_ps optional loss_of_sync_c ount_ps optional node_id Reference to the associated node on which these metrics optional were recorded. string prim_seq_prot _err_count_ps Primitive sequence protocol error count per second.
Name Description Schema Unaligned total input/output per second. number (float) Unaligned read rate in bytes per second. number (float) Unaligned read input/output per second. number (float) te_bandwidth Unaligned write rate in bytes per second. number (float) unaligned_iop s optional unaligned_rea d_bandwidth optional unaligned_rea d_iops optional unaligned_wri optional unaligned_wri te_iops Unaligned write input/output per second. number (float) Write rate in byte/sec.
Name Description Schema Average invalid crc count per second. number (float) Average invalid transmission word count per second. number (float) Average size of read and write operations in bytes. number (float) Weighted average latency in microseconds. number (float) Average link failure count per second.
Name avg_read_size optional Description Schema Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number Average unaligned read/write rate in bytes per second. number (float) Average unaligned total input/output per second. number (float) Average unaligned read rate in bytes per second. number (float) Average unaligned read input/output per second.
Name Description Schema Weighted average write latency in microseconds. number (float) Weighted average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity MetricsEntityEnum required entity_l10n optional max_avg_io_si ze optional Localized message string corresponding to entity Maximum average size of input and output operations in bytes. string number (float) max_avg_late ncy Maximum of average latency in microseconds.
Name Description Schema The maximum invalid crc count per second. number (float) max_invalid_c rc_count_ps optional max_invalid_t x_word_count _ps The maximum invalid transmission word count per second. number (float) optional max_link_fail ure_count_ps The maximum link failure count per second. number (float) The maximum loss of signal count per second. number (float) The maximum loss of sync count per second.
Name Description Schema Maximum unaligned read/write rate in bytes per second. number (float) Maximum unaligned total input/output per second. number (float) Maximum unaligned read rate in bytes per second. number (float) Maximum unaligned read input/output per second. number (float) Maximum unaligned write rate in bytes per second. number (float) Maximum unaligned write input/output per second. number (float) Maximum write bandwidth in bytes per second.
performance_metrics_by_fe_fc_port Performance metrics for the frontend fibre channel port collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. avg_io_size optional avg_latency optional Schema string Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds.
Name Description fe_port_id Reference to the associated frontend fibre channel port optional (fc_port) on which these metrics were recorded. Schema string invalid_crc_co unt_ps Invalid crc count per second. number (float) Invalid transmission word count per second. number (float) Link failure count per second. number (float) Loss of signal count per second. number (float) Loss of sync count per second. number (float) Reference to the node the port belongs to.
Name Description Schema Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number (float) Unaligned read/write rate in bytes per second. number (float) Unaligned total input/output per second. number (float) Unaligned read rate in bytes per second. number (float) Unaligned read input/output per second. number (float) te_bandwidth Unaligned write rate in bytes per second.
Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. avg_current_l Average number of logins to the target from initiators. ogins Minimum value : 0 optional Maximum value : 9223372036854775807 Schema string integer (int64) avg_dumped_f rames_ps Average dumped frames per second. number (float) Average invalid crc count per second. number (float) Average invalid transmission word count per second.
Name Description Schema Weighted average read bandwidth in bytes per second. number (float) Average reads per second. number (float) Weighted average read latency in microseconds. number (float) Weighted average read size in bytes. number (float) Weighted average total bandwidth in bytes per second. number (float) Average total input and output operations per second. number Average unaligned read/write rate in bytes per second. number (float) Average unaligned total input/output per second.
Name Description Schema Average unaligned write input/output per second. number (float) Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) max_avg_writ e_latency optional max_avg_writ e_size optional max_current_ Maximum number of logins to the target from initiators. logins Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_dumped_ frames_ps The maximum dumped frames per second. number (float) The maximum invalid crc count per second.
Name Description Schema Maximum read bandwidth in bytes per second. number (float) Maximum reads per second. number (float) Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum unaligned read/write rate in bytes per second. number (float) Maximum unaligned total input/output per second. number (float) Maximum unaligned read rate in bytes per second. number (float) Maximum unaligned read input/output per second.
Name Description Schema Maximum write bandwidth in bytes per second. number (float) Maximum writes per second. number (float) Reference to the node the port belongs to. string max_write_ba ndwidth optional max_write_io ps optional node_id optional repeat_count optional timestamp optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period.
Name avg_write_size optional Description Schema Average write size in bytes. number (float) entity MetricsEntityEnum required entity_l10n optional file_system_id optional Localized message string corresponding to entity string Unique identifier of the file system. string Read rate in bytes per second. number (float) Total read operations per second.
performance_metrics_by_file_system_rollup Summary of file system level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Polymorphism : Inheritance Discriminator : entity Name Description Schema avg_latency Maximum optional microseconds. of average read and write latency in number (float) avg_read_ban dwidth Average read rate in bytes per second. number (float) Average read operations per second.
Name Description Schema Maximum of average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity MetricsEntityEnum required entity_l10n optional file_system_id optional max_avg_late ncy optional Localized message string corresponding to entity string Unique identifier of the file system. string Maximum of average read and write latency microseconds.
Name Description Schema Maximum read rate in bytes per second. number (float) Maximum read operations per second. number (float) Maximum data transfer rate in bytes per second. number (float) Maximum write rate in bytes per second. number (float) Maximum write operations per second.
Name Description Schema Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes.
performance_metrics_by_nfs_rollup Summary of nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional avg_latency optional avg_read_iops optional Description Schema Average read and write size in bytes. number (float) Maximum read and write latency in microseconds. number (float) Average read operations per second.
Name Description Schema Maximum of average read and write size in bytes. number (float) max_avg_io_si ze optional max_avg_late ncy optional Maximum of average read and write latency in microseconds. number (float) max_avg_read _latency Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes.
Name timestamp optional Description Schema Time at the beginning of sample period. string (date-time) performance_metrics_by_nfsv3 Performance metrics for the nfs collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name Description Schema Average md latency operations per second.
Name total_iops optional write_iops optional Description Schema Total read and write iops in microseconds. number (float) Total write iops in microseconds. number (float) performance_metrics_by_nfsv3_rollup Summary of nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period. Polymorphism : Inheritance Discriminator : entity Name Description Schema Average failed operations per second.
Name Description Schema Maximum average md latency per second. number (float) Max failed operations per second. number (float) Maximum read operations per second. number (float) Maximum read and write operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node.
Name Description entity MetricsEntityEnum required entity_l10n optional failed_md_ops optional md_ops optional node_id optional read_iops optional Schema Localized message string corresponding to entity string Total failed md operations per second. number (float) Total md operations per second. number (float) Unique identifier of the nfs. string Total read iops in microseconds.
Name Description Schema Average failed operations per second. number (float) Average md latency per second. number (float) Average md operations per second. number (float) Average read operations per second. number (float) Average read and write operations per second. number (float) Average write operations per second.
Name Description Schema Maximum write operations per second. number (float) Unique identifier of the node. string max_write_io ps optional node_id optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp optional Time at the beginning of sample period.
Name avg_write_size optional Description Schema Average write size in bytes. number (float) current_login The number of logins to the target from initiators. s Minimum value : 0 optional Maximum value : 9223372036854775807 entity MetricsEntityEnum required entity_l10n optional io_workload_c pu_utilization optional node_id optional integer (int64) Localized message string corresponding to entity The percentage of CPU Utilization on the cores dedicated to servicing storage I/O requests.
Name Description Schema Unaligned read/write rate in bytes per second. number (float) Unaligned total input/output per second. number (float) Unaligned read rate in bytes per second. number (float) Unaligned read input/output per second. number (float) te_bandwidth Unaligned write rate in bytes per second.
Name Description avg_current_l Average number of logins to the target from initiators. ogins Minimum value : 0 optional Maximum value : 9223372036854775807 avg_io_size optional Average size of read and write operations in bytes. Schema integer (int64) number (float) avg_io_worklo The average percentage of CPU Utilization on the cores ad_cpu_utiliza dedicated to servicing storage I/O requests. Calculated over tion time across appliance.
Name Description Schema Average unaligned read rate in bytes per second. number (float) Average unaligned read input/output per second. number (float) Average unaligned write rate in bytes per second. number (float) Average unaligned write input/output per second. number (float) Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum of average latency in microseconds. number (float) Maximum read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes.
Name Description Schema Maximum unaligned read/write rate in bytes per second. number (float) Maximum unaligned total input/output per second. number (float) Maximum unaligned read rate in bytes per second. number (float) Maximum unaligned read input/output per second. number (float) Maximum unaligned write rate in bytes per second. number (float) Maximum unaligned write input/output per second. number (float) Maximum write bandwidth in bytes per second.
performance_metrics_by_smb_cache Performance metrics for the smb cache collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name Description entity MetricsEntityEnum required entity_l10n optional Schema Localized message string corresponding to entity string Average hash latency. number (float) Average hash size. number (float) Max hash latency. number (float) Max hash size. number (float) Min hash latency. number (float) Max hash size.
Name Description Schema Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values. If the value is omitted from the response, it is 1 (no additional repeats). integer (int32) Minimum value : 0 Maximum value : 2147483647 timestamp optional End of sample period. string (date-time) Total rejected task. number (float) Total tasks.
Name Description Schema Average max hash size. number (float) Max hash latency. number (float) Max hash size. number (float) Min hash latency. number (float) Max hash size. number (float) Max used threads number (float) Unique identifier of the node.
performance_metrics_by_smb_client Performance metrics for the smb client collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional avg_latency optional Description Schema Average read and write size in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds.
Name timestamp optional total_calls optional total_iops optional write_iops optional Description Schema End of sample period. string (date-time) Total calls. number (float) Total read and write operations per second. number (float) Total write operations per second. number (float) performance_metrics_by_smb_client_rollup Summary of smb client level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.
Name Description Schema Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_iop s optional avg_write_late ncy optional avg_write_size optional entity MetricsEntityEnum required entity_l10n optional max_avg_late ncy optional Localized message string corresponding to entity Maximum of average read and write latency microseconds.
Name max_iops optional Description Schema Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node. string max_read_iop s optional max_write_io ps optional node_id optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values.
Name Description Schema Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity MetricsEntityEnum required entity_l10n optional node_id optional read_iops optional Localized message string corresponding to entity string Unique identifier of the node. string Total read operations per second.
Name avg_calls optional avg_io_size optional avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average calls. number (float) Average read and write size in bytes. number (float) Average read and write operations per second. number (float) Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes.
Name Description Schema Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second.
performance_metrics_by_smb_v1_builtin_client Performance metrics for the smb v1 client collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional avg_latency optional Description Schema Average read and write size in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds.
Name timestamp optional total_calls optional total_iops optional write_iops optional Description Schema End of sample period. string (date-time) Total calls. number (float) Total read and write operations per second. number (float) Total write operations per second. number (float) performance_metrics_by_smb_v1_builtin_client_rollup Summary of smb v1 client level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.
Name Description Schema Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_iop s optional avg_write_late ncy optional avg_write_size optional entity MetricsEntityEnum required entity_l10n optional max_avg_late ncy optional Localized message string corresponding to entity Maximum of average read and write latency microseconds.
Name max_iops optional Description Schema Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node. string max_read_iop s optional max_write_io ps optional node_id optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values.
Name Description Schema Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity MetricsEntityEnum required entity_l10n optional node_id optional read_iops optional Localized message string corresponding to entity string Unique identifier of the node. string Total read operations per second.
Name avg_calls optional avg_io_size optional avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average calls. number (float) Average read and write size in bytes. number (float) Average read and write operations per second. number (float) Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes.
Name Description Schema Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second.
performance_metrics_by_smb_v2_builtin_client Performance metrics for the smb v1 client collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional avg_latency optional Description Schema Average read and write size in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds.
Name timestamp optional total_calls optional total_iops optional write_iops optional Description Schema End of sample period. string (date-time) Total calls. number (float) Total read and write operations per second. number (float) Total write operations per second. number (float) performance_metrics_by_smb_v2_builtin_client_rollup Summary of smb v1 client level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.
Name Description Schema Average write operations per second. number (float) Maximum write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_iop s optional avg_write_late ncy optional avg_write_size optional entity MetricsEntityEnum required entity_l10n optional max_avg_late ncy optional Localized message string corresponding to entity Maximum of average read and write latency microseconds.
Name max_iops optional Description Schema Maximum read and write operations per second. number (float) Maximum read operations per second. number (float) Maximum write operations per second. number (float) Unique identifier of the node. string max_read_iop s optional max_write_io ps optional node_id optional Number of consecutive sampling periods during which repeat_count optional there were no changes in the metrics values.
Name Description Schema Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity MetricsEntityEnum required entity_l10n optional node_id optional read_iops optional Localized message string corresponding to entity string Unique identifier of the node. string Total read operations per second.
Name avg_calls optional avg_io_size optional avg_iops optional avg_latency optional avg_read_iops optional Description Schema Average calls. number (float) Average read and write size in bytes. number (float) Average read and write operations per second. number (float) Maximum read and write latency in microseconds. number (float) Average read operations per second. number (float) Maximum read latency in microseconds. number (float) Average read size in bytes.
Name Description Schema Maximum of average read latency in microseconds. number (float) Maximum of average read size in bytes. number (float) Maximum of average read and write size in bytes. number (float) Maximum of average write latency in microseconds. number (float) Maximum of average write size in bytes. number (float) Maximum calls. number (float) Maximum read and write operations per second. number (float) Maximum read operations per second.
performance_metrics_by_vg Performance metrics for the volumes in a volume group collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes. number (float) Average read and write latency in microseconds. number (float) Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds.
Name timestamp optional Description Schema End of sample period. string (date-time) Total data transfer rate in bytes per second. number (float) Total read and write operations per second. number (float) Unique identifier representing a volume group. string Write rate in byte/sec. number (float) Total write operations per second.
Name Description Schema Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity MetricsEntityEnum required entity_l10n optional Localized message string corresponding to entity string Read rate in bytes per second. number (float) Total read operations per second.
performance_metrics_by_vm_rollup Summary of virtual machine level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period. Polymorphism : Inheritance Discriminator : entity Name avg_io_size optional avg_latency optional Description Schema Average size of read and write operations in bytes. number (float) Weighted average latency in microseconds. number (float) Weighted average read bandwidth in bytes per second.
Name Description Schema Weighted average write latency in microseconds. number (float) Weighted average write size in bytes. number (float) avg_write_late ncy optional avg_write_size optional entity MetricsEntityEnum required entity_l10n optional max_avg_io_si ze optional Localized message string corresponding to entity Maximum average size of input and output operations in bytes. string number (float) max_avg_late ncy Maximum of average latency in microseconds.
Name Description Schema Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum write bandwidth in bytes per second. number (float) Maximum writes per second. number (float) max_total_ba ndwidth optional max_total_iop s optional max_write_ba ndwidth optional max_write_io ps optional repeat_count optional timestamp optional vm_id optional Number of times the metrics are repeated.
Name Description Schema Average read latency in microseconds. number (float) Average read size in bytes. number (float) Average write latency in microseconds. number (float) Average write size in bytes. number (float) avg_read_late ncy optional avg_read_size optional avg_write_late ncy optional avg_write_size optional entity MetricsEntityEnum required entity_l10n optional Localized message string corresponding to entity string Read rate in bytes per second.
Name Description Schema Write rate in byte/sec. number (float) Total write operations per second. number (float) write_bandwi dth optional write_iops optional performance_metrics_by_volume_rollup Summary of volume level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period.
Name avg_total_iops optional Description Schema Average total input and output operations per second. number Weighted average write bandwidth in bytes per second. number (float) Average writes per second. number (float) Weighted average write latency in microseconds. number (float) Weighted average write size in bytes.
Name Description Schema Maximum of average write size in bytes. number (float) Maximum read bandwidth in bytes per second. number (float) Maximum reads per second. number (float) Maximum total bandwidth in bytes per second. number (float) Maximum totals per second. number Maximum write bandwidth in bytes per second. number (float) Maximum writes per second.
Name id optional Description Schema Unique identifier representing a performance rule. string io_priority IoPriorityEnum optional io_priority_l10 n Localized message string corresponding to io_priority string optional name Name of the performance rule. This property supports optional case-insensitive filtering policies List optional performance_rule.
physical_switch_connection_instance This resource type has queriable association from physical_switch Name address optional Description Schema Physical switch address in IPv4 or IPv6 or DNS hostname format.
Name port optional Description Schema Port used for connection to switch. Minimum value : 0 integer (int32) Maximum value : 65535 snmp_commu SNMPv2 community string, if SNMPv2c connect method is nity_string specified. optional Maximal length : 128 ssh_password optional username optional string (password) SSH password to connect a physical switch if SSH connect string (password) method is specified. Maximal length : 128 Username to connect a physical switch for SSH connection method.
Name Description id Unique identifier of the physical switch setting. optional Length : 1 - 32 name optional Schema string Name of physical switch. This property supports caseinsensitive filtering string Length : 1 - 128 purpose PhysicalSwitchPurp optional oseEnum purpose_l10n optional Localized message string corresponding to purpose string physical_switch_modify Name Description Schema < connections optional Supported connections for a physical switch.
Name Description Schema snapshot_rule Snapshot rule identifiers included in this policy. At least _ids one snapshot rule or one replication rule must be specified < string > array optional to create a protection policy. policy_instance Properties of a policy. This resource type has queriable associations from performance_rule, snapshot_rule, replication_rule, virtual_machine, volume, volume_group, file_system Name description optional Description Schema Policy description.
Name type_l10n optional virtual_machi nes optional volume_group s optional volumes optional Description Schema Localized message string corresponding to type string This is the inverse of the resource type virtual_machine association. This is the inverse of the resource type volume_group association. This is the inverse of the resource type volume association. < virtual_machine_ins tance > array < volume_group_insta nce > array < volume_instance > array policy_modify Policy modify request.
Name replication_ru le_ids optional snapshot_rule _ids optional Description Replication rule identifiers that should replace the current list of replication rule identifiers in this policy. Snapshot rule identifiers that should replace the current list of snapshot rule identifiers in this policy. Schema < string > array < string > array protection_data_instance Protection data associated with a resource. Filtering on the fields of this embedded resource is not supported.
Name is_app_consist ent optional Description Schema A boolean flag that indicates whether the snapshot is application consistent. Only App Sync can create application consistent snapshots. boolean Default : false Unique identifier of the resource from which a snapshot or clone resource is created. The parent_id is set when a parent_id optional resource is created and will only change if its parent resource is deleted.
Name import_chap_i nfo optional Description Chap information to be used for session and discovery. This chap_credentials_ins is applicable to non-PowerStore remote systems. iscsi_addresse iSCSI target IP addresses for the data connection to the s remote system. Must be specified when creating a non- optional PowerStore remote system. management_ address required Schema tance < string (ip-address) > array Management IP address of the remote system instance.
Name Description Schema data_connecti on_state DataConnectionState State of the data connection. Enum optional data_connecti on_state_l10n optional Localized message string corresponding to data_connection_state string List of data connections from each appliance in the local data_connecti cluster to iSCSI target IP address. < ons data_connection_ins Filtering on the fields of this embedded resource is not tance > array optional supported.
Name Description Schema Management IP address of the remote system instance. string (ip-address) management_ address optional name optional replication_se ssions optional User-specified name of the remote system instance. string This property supports case-insensitive filtering This is the inverse of the resource type replication_session association. < replication_session_i nstance > array serial_numbe r Serial number of the remote system instance.
Name Description data_network _latency Network latency for the PowerStore remote system. optional description User-specified description of the remote system. optional Maximal length : 256 Schema RemoteSystemLaten cyEnum string management_ address Management IP address of the remote system. string (ip-address) optional User-specified name of the remote system. Used only for name non-PowerStore type remote systems. This value must optional contain 128 or fewer printable Unicode characters.
Name replication_sh adow_id optional Description Unique identifier of the internal snap used for replicating data. storage_eleme nt_type Storage element type. optional Schema string StorageElementType Enum replication_rule_create Replication rule create request. Name Description Schema Acceptable delay in minutes between the expected and actual replication sync intervals. The system generates an alert_threshol alert if the delay between the expected and actual sync d exceeds this threshold.
Name Description Schema Acceptable delay in minutes between the expected and actual replication sync intervals. The system generates an alert_threshol alert if the delay between the expected and actual sync d exceeds this threshold. Alert threshold has the default integer (int32) optional value of one RPO in minutes. Minimum value : 0 Maximum value : 1440 id optional Unique identifier of the replication rule.
Name Description Schema Acceptable delay in minutes between the expected and alert_threshol d optional actual replication sync intervals. The system generates an alert if the delay between the expected and actual sync exceeds this threshold. integer (int32) Minimum value : 0 Maximum value : 1440 name optional remote_syste m_id optional Name of the replication rule. string Unique identifier of the remote system to which this rule will replicate the associated resources.
Name Description Schema estimated_co mpletion_tim Estimated completion time of the current replication estamp operation. string (date-time) optional id optional Unique identifier of the replication session instance. string Time of last successful synchronization. string (date-time) last_sync_time stamp optional local_resourc e_id optional migration_ses sion optional Unique identifier of the local storage resource for the replication session.
Name resource_type optional Description Type of the storage resource. Schema ReplicatedResourceT ypeEnum resource_type _l10n Localized message string corresponding to resource_type string optional role optional role_l10n optional state optional state_l10n optional Role of the replication session. Localized message string corresponding to role Current state of the replication session.
Name is_built_in optional name optional Description Schema Indicates whether the role is built-in. boolean Name of the role. string sas_port_instance This resource type has queriable associations from appliance, hardware, sas_port Name Description appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id optional id optional Schema appliance_instance Unique identifier of the appliance containing the port. string Unique identifier of the SAS port.
Name Description partner This is the embeddable reference form of partner_id optional attribute. partner_id optional port_index optional sfp optional Unique identifier of the SAS partner port. Minimum value : 0 string integer (int32) Maximum value : 2147483647 This is the embeddable reference form of sfp_id attribute. Unique identifier of the hardware instance of type 'SFP' optional (Small Form-factor Pluggable) inserted into the port.
Name Description Schema Length of time to keep snapshots before deleting them, in expiration minutes. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 frequency optional Frequency at which the snapshot will be taken. ScScheduleTypeEnu m frequency_l10 n Localized message string corresponding to frequency string optional Time interval between any two snapshot creations, in interval minutes.
security_config_instance Name id optional Description Schema Unique identifier of the system security configuration. string Idle time (in seconds) after which login sessions will expire idle_timeout and require re-authentication. optional Minimum value : 0 integer (int32) Maximum value : 2147483647 service_config_instance Name appliance_id optional id optional Description Schema Unique identifier of the appliance. string Unique identifier for the service configuration instance.
Name id optional is_built_in optional Description Schema Unique identifier of the service user account. string Whether the user account is built-in or not. boolean Whether the user account has the default password or not. boolean is_default_pas sword optional name Name of the service user account. Always 'service' in this optional release. string service_user_modify Name Description Schema New password for the service user account.
Name Description Schema DNS name of the associated computer account when the SMB server is joined to an Active Directory domain. This name is limited to 63 bytes and must not contain the following characters - - comma (.) - tilde (~) - colon (:) computer_na me optional exclamation point (!) - at sign (@) - number sign (#) - dollar sign ($) - percent (%) - caret (^) - ampersand (&) apostrophe (') - period (.
Name Description Schema NetBIOS name is the network name of the standalone SMB server. SMB servers joined to Active Directory also have NetBIOS Name, defaulted to the 15 first characters of the computer_name attribute. Administrators can specify a custom NetBIOS Name for a SMB server using this netbios_name optional attribute.
Name Description Schema DNS name of the associated computer account when the SMB server is joined to an Active Directory domain. This name’s minimum length is 2 characters, it is limited to 63 bytes and must not contain the following characters - computer_na me optional comma (.) - tilde (~) - colon (:) - exclamation point (!) - at sign (@) - number sign (#) - dollar sign ($) - percent (%) caret (^) - ampersand (&) - apostrophe (') - period (.
Name Description Schema NetBIOS name is the network name of the standalone SMB server. SMB server joined to Active Directory also have NetBIOS Name, defaulted to the 15 first characters of the computerName attribute. Administrators can specify a custom NetBIOS Name for a SMB server using this netbios_name attribute.
Name Description Schema DNS Name of the associated Computer Account when the SMB server is joined to an Active Directory domain. This name is limited to 63 bytes and must not contain the following characters - - comma (.) - tilde (~) - colon (:) computer_na me optional exclamation point (!) - at sign (@) - number sign (#) - dollar sign ($) - percent (%) - caret (^) - ampersand (&) apostrophe (') - period (.
Name Description Schema Applies to standalone SMB servers only. Windows network workgroup workgroup for the SMB server. Workgroup names are optional limited to 15 alphanumeric ASCII characters. string Length : 1 - 15 smb_server_unjoin Argument to ujoin the SMB server from an Active Directory domain.
Name Description Schema Indicates whether BranchCace optimization is enabled. BranchCache optimization technology copies content from is_branch_cac he_enabled optional your main office or hosted cloud content servers and caches the content at branch office locations, allowing client computers at branch offices to access the content boolean locally rather than over the WAN. Values are: - true BranchCache is enabled. - false - BranchCache is disabled.
smb_share_instance This resource type has queriable association from file_system Name description optional Description Schema User defined SMB share description. string file_system This is the embeddable reference form of file_system_id optional attribute. file_system_id optional id optional file_system_instance The file system from which the share was created. string Id of the SMB Share. string Indicates whether Access-based Enumeration (ABE) is is_ABE_enable enabled.
Name Description Schema offline_availa SMBShareOfflineAv bility ailabilityEnum optional offline_availa bility_l10n optional Localized message string corresponding to offline_availability string Local path to the file system or any existing sub-folder of the file system that is shared over the network. This path is relative to the NAS Server and must start with the path optional filesystem’s mountpoint path, which is the filesystem name.
Name is_continuous _availability_e nabled optional is_encryption_ enabled optional Description Indicates whether continuous availability for Server Message Block (SMB) 3.0 is enabled for the SMB Share. Values are: - true - Continuous availability for SMB 3.0 is boolean enabled for the SMB Share. - false - Continuous availability for SMB 3.0 is disabled for the SMB Share. Indicates whether encryption for Server Message Block (SMB) 3.0 is enabled at the shared folder level.
Name port optional source_email optional Description Schema Port used for sending SMTP messages. Minimum value : 0 integer (int32) Maximum value : 65535 Source email address used for sending SMTP messages. string smtp_config_test Name email_address optional Description Schema Destination email address for the test. string snapshot_rule_create Snapshot rule create request. Name Description days_of_week Days of the week when the rule should be applied.
Name delete_snaps optional Description Schema Specify whether all snapshots previously created by this rule should also be deleted when this rule is removed. boolean Default : false snapshot_rule_instance Snapshot rule instance. This resource type has queriable association from policy Name Description Schema days_of_week Days of the week when the rule should be applied. Applies < DaysOfWeekEnum optional only for rules where the time_of_day parameter is set.
Name Description Schema Time of the day to take a daily snapshot, with format time_of_day "hh:mm" in 24 hour time format. Either the interval optional parameter or the time_of_day parameter will be set, but not string (timestamp) both. snapshot_rule_modify Snapshot rule modify request. Name Description days_of_week Days of the week when the rule should be applied. Applies < DaysOfWeekEnum optional only for rules where the time_of_day parameter is set.
Name installed_date optional Description Schema Date and time when the software was successfully installed and committed on the cluster. If the software package has string (date-time) not been commited, this value is null. Whether this information represents the common software is_cluster release version that is supported on all appliances in the optional cluster. The value is true for the instance representing the boolean cluster. The value is false for appliance software instances.
Name justification_l 10n optional Description Schema Explanation of why this software release is recommended for this cluster. name Name of the software package. This property supports case- optional insensitive filtering string string release_timest amp Date and time when this software package was produced. string (date-time) Version number of the software package. string optional release_versio n optional size optional File size of the software package in bytes.
Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. data_physical _used optional data_reductio n optional Schema string This metric represents amount of physical space user data occupies after deduplication and compression. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Ratio of the logical used space to data physical used space which is after deduplication and compression.
Name Description Schema Total physical space consumed in the appliance, accounting physical_used for all efficiency mechanisms, as well as all data protection. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 repeat_count optional Number of times the metrics are repeated.
Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. entity optional string MetricsEntityEnum required entity_l10n Schema Localized message string corresponding to entity last_data_phy Last physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 string integer (int64) last_data_red uction Last data reduction space during the period.
Name Description Schema Last thin savings ratio during the period. number (float) last_thin_savi ngs optional max_data_phy Maximum physical used space for data during the period. sical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_data_red uction Maximum data reduction space during the period. number (float) Maximum efficiency ratio during the period.
Name repeat_count optional timestamp optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) space_metrics_by_cluster Space metrics for the cluster collected at five minute interval. Polymorphism : Inheritance Discriminator : entity Name cluster_id optional data_physical _used optional data_reductio n optional Description Schema Identifier of the cluster.
Name logical_provis ioned optional Description Schema Total configured size of all storage ojects within the cluster. This metric includes all primaries, snaps and clones. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 Amount of data in bytes written to all storage objects within the cluster, without any deduplication and/or logical_used compression. This metric includes all primaries, snaps and optional clones.
Name Description Schema Ratio of all the vVol provisioned to data they contain. This is the ratio of logical_provisioned to logical_used. For thin_savings example, a cluster has two 2 GB objects and have written optional 500 MB bytes of data to them. The thin savings would be (2 number (float) * 2 GB) / (2 * 0.5 GB) or 4:1, so the thin_savings value would be 4.0. timestamp optional End of sample period.
Name Description Schema last_logical_pr Last logical total space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_physical_ Last physical total space during the period.
Name Description Schema max_logical_u Maximum logical used space during the period. sed Minimum value : 0 optional Maximum value : 9223372036854775807 max_physical Maximum physical total space during the period. _total Minimum value : 0 optional Maximum value : 9223372036854775807 max_physical Maximum physical used space during the period.
Name entity_l10n optional logical_provis ioned optional Description Schema Localized message string corresponding to entity string Total configured size in bytes of the primary and clone virtual volumes within the storage container. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 Amount of data in bytes written to primary and clone logical_used virtual volumes within the storage container.
Name Description entity MetricsEntityEnum required entity_l10n optional Schema Localized message string corresponding to entity string last_logical_pr Last logical provisioned space during the period. ovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_logical_us Last logical used space during the period.
space_metrics_by_vg Space metrics for a volume group collected at a five minute interval. Polymorphism : Inheritance Discriminator : entity Name Description entity MetricsEntityEnum required entity_l10n optional logical_provis ioned optional Schema Localized message string corresponding to entity string Total configured size in bytes of all member volumes in a volume group.
Name Description Schema Ratio of all the volumes provisioned to data being written thin_savings optional to them. For example, a volume group has two 2 GB volumes and have written 500 MB of data to them. The thin number (float) savings would be (2 * 2 GB) / (2 * 0.5 GB) or 4:1, so the thin_savings value would be 4.0. timestamp optional vg_id optional End of sample period. string (date-time) Unique identifier representing a volume group.
Name Description Schema Last thin savings ratio during the period. number (float) last_thin_savi ngs optional max_logical_p Max logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Maximum logical used space during the period.
Name Description Schema entity MetricsEntityEnum required entity_l10n optional logical_provis ioned optional Localized message string corresponding to entity string Total configured size in bytes of all virtual volumes used by virtual machine. integer (int64) Minimum value : 0 Maximum value : 9223372036854775807 Total amount of data in bytes written to all virtual volumes logical_used used by virtual machine.
Name Description Schema Amount of physical space virtual machine used after unique_physic compression and deduplication. This is the space to be al_used freed up if a virtual machine is removed. optional Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 vm_id optional Unique identifier representing a specific virtual machine.
Name Description Schema last_unique_p Last unique physical used space during the period. hysical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_p Max logical provisioned space during the period. rovisioned Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_logical_u Max logical used space during the period.
Discriminator : entity Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. entity optional string MetricsEntityEnum required entity_l10n Schema Localized message string corresponding to entity string Configured size in bytes of a volume which amount of data logical_provis can be written to. This metric includes primaries, snaps ioned and clones.
Discriminator : entity Name Description appliance_id Reference to the associated appliance on which these optional metrics were recorded. entity optional family_id optional string MetricsEntityEnum required entity_l10n Schema Localized message string corresponding to entity string ID of the family. string Configured size in bytes of a volume which amount of data logical_provis can be written to. This metric includes primaries, snaps ioned and clones.
Name Description Schema Ratio of the amount of space that would have been used by snapshots if space efficiency was not applied to logical snapshot_savi space used solely by snapshots. For example, a volume is ngs provisioned as 1 GB bytes and it has two snapshots. Each number (float) optional snapshot has 200 MB of data. Snapshot savings will be (1 GB + 1 GB) / (0.2 GB + 0.2 GB) or 5:1. The snapshot_savings value will be 5 in this case. timestamp optional End of sample period.
Name Description Schema last_logical_us Last logical used space during the period. ed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_shared_lo Last shared logical used space during the period. gical_used Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) last_snap_clon Last snap and clone logical used space during the period.
Name repeat_count optional timestamp optional Description Schema Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) space_metrics_by_volume_rollup Summary of volume level space metric data for one hour or one day period beginning with timestamp, including the maximum and final values for that period.
Name Description Schema max_logical_u Max logical used space during the period. sed Minimum value : 0 optional Maximum value : 9223372036854775807 integer (int64) max_thin_savi ngs Max thin savings ratio during the period. number (float) optional repeat_count optional timestamp optional volume_id optional Number of times the metrics are repeated. Minimum value : 0 integer (int32) Maximum value : 2147483647 End of sample period. string (date-time) ID of the volume.
Name Description Schema Normally, deletion of a storage container that is mounted force or still contains virtual volumes will be rejected. This optional option overrides that error and allows the delete to boolean continue. Use with great caution. storage_container_instance A storage container is a logical grouping of related storage objects. For example, a storage container maps to a vVol datastore in vSphere where the storage for virtual machines can be provisioned.
Name Description Schema The number of bytes that can be provisioned against this quota optional storage container. It cannot be set lower than the current used space or 10Gb. A value of 0 means unlimited. integer (int64) Minimum value : 0 Maximum value : 4611686018427387904 storage_container_mount Properties for mounting storage container. Name datastore_na me optional Description Schema This will be the vVol datastore name in vCenter when it is mounted.
Name port_name optional Description Schema Initiator name string vcenter_create Name Description address IP address of vCenter host, in IPv4, IPv6, or hostname optional format. password optional username optional Schema string (ip-address) Password to login to vCenter. string (password) User name to login to vCenter. string vcenter_instance Properties of a vCenter. Name Description address IP address of vCenter host, in IPv4, IPv6, or hostname optional format.
Name password optional Description Schema Password to login to vCenter. string (password) username User name to login to vCenter. Password needs to be optional provided to modify the user name. string veth_port_instance This resource type has queriable associations from ip_port, appliance, node Name Description appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id optional Unique identifier of the appliance.
Name Description name Virtual Ethernet port name. This property supports case- optional insensitive filtering node optional node_id optional vswitch_port_ group_name optional vswitch_port_i d optional string This is the embeddable reference form of node_id attribute. node_instance Unique identifier of the cluster. vswitch_name Name of the virtual switch that holds the virtual Ethernet optional Schema port. Name of virtual switch port group to which the virtual Ethernet port is assigned.
Name Description guest_os Guest operating system of the VM. Not applicable to VM optional snapshots. id Unique identifier of the VM instance. This value is optional generated by the appliance. instance_uuid optional is_consistent optional Schema string string UUID instance of the VM in vCenter. This value is stored in the VM and migrates with the VM to other vCenter string instances. Not applicable to VM snapshots. Indicates whether the VM snapshot is crash-consistent.
Name status_l10n optional Description Schema Localized message string corresponding to status string type VirtualMachineType optional Enum type_l10n optional Localized message string corresponding to type string UUID instance of the vCenter that hosts the VM. string vcenter_insta nce_uuid optional virtual_machine_modify Name Description Schema Unique identifier of the protection policy.
virtual_volume_delete Parameters for virtual volume delete. Name force optional Description Schema Normally, attempting to delete a bound virtual volume is not permitted. This option overrides that error and allows boolean the delete to continue. virtual_volume_instance A virtual volume.
Name Description Schema host_virtual_v < olume_mappi This ngs host_virtual_volume_mapping association. is the inverse of the resource type host_virtual_volume _mapping_instance > optional id optional array The unique identifier of the virtual volume. string io_priority IoPriorityEnum optional io_priority_l10 n Localized message string corresponding to io_priority string Indicates whether the virtual volume is read-only.
Name size optional Description Schema The size of the virtual volume in bytes. Minimum value : 0 integer (int64) Maximum value : 9223372036854775807 source This is the embeddable reference form of source_id virtual_volume_inst optional attribute. ance Id of the virtual volume from which the content has been source_id sourced. Data is sourced from another virtual volume when optional a snapshot or clone is created, or when a refresh or restore string occurs. Only applies to snap and clones.
vm_protection_data_instance Protection data associated with the VM snapshot. Filtering on the fields of this embedded resource is not supported. Name created_by_ru le_id optional Description Unique identifier of the protection rule that created the VM snapshot. Schema string created_by_ru Name of the rule that created the VM snapshot. This value le_name is not updated if the name of the rule changes after string optional snapshot creation.
Name Description host_id Unique identifier of the host to be attached to the volume. optional Only one of host_id or host_group_id can be supplied. Schema string logical_unit_n Logical unit number for the host volume access. umber Minimum value : 0 optional Maximum value : 16383 integer (int32) volume_clone Name description optional Description Schema Description of the clone. This value must contain 128 or fewer printable Unicode characters.
Name Schema id string optional volume_create Name Description appliance_id Identifier of the appliance on which the volume is optional provisioned. description optional host_group_id optional host_id optional Schema string Description of the volume. This value must contain 128 or fewer printable Unicode characters. string Maximal length : 128 Unique identifier of the host group to be attached to the volume. If not specified, an unmapped volume is created.
Name Description Schema Optional sector size, in bytes. Only 512-byte and 4096-byte sector_size sectors are supported. optional Minimum value : 512 integer (int32) Maximum value : 4096 Size of the volume to be created, in bytes. Minimum size required volume size is 1MB. Maximum volume size is 256TB. Size must be a multiple of 8192. integer (int64) Minimum value : 1048576 Maximum value : 281474976710656 volume_group _id optional Volume group to add the volume to.
Name description optional is_replication _destination optional name required protection_po licy_id optional Description Schema Description for the clone volume group. If description is not specified, the description for the snapshot set will not be string set. A boolean flag to indicate whether the clone volume group is a destination of a replication session. This parameter defaults to false, if not specified. boolean Default : false Unique name for the clone volume group.
Name Description Schema Unique name for the volume group. The name should contain no special HTTP characters and no unprintable name characters. Although the case of the name provided is required reserved, uniqueness check is case-insensitive, so the same string name in two different cases is not considered unique. Maximal length : 128 protection_po licy_id optional Unique identifier of an optional protection policy to assign to the volume group.
Name description optional id optional is_importing optional Description Schema Description for the volume group. string Unique identifier of the volume group. string Indicates whether the volume group is being imported. boolean This is a derived field that is set internally. It enables/disables the following functionality: is_protectable optional • Whether a protection_policy can be applied to the group. boolean • Whether manual snapshots can be taken.
Name migration_ses sion optional migration_ses sion_id optional Description This is Schema the embeddable reference form of migration_session_i migration_session_id attribute. nstance Unique identifier of the migration session assigned to the volume group when it is part of a migration activity. name Name of the volume group.
Name Description Schema New description for the volume group. The description description should not have any unprintable characters. If an empty optional string is specified, the description will be cleared. string Maximal length : 256 Normally a replication destination volume group cannot be modified since it is controlled by replication. However, there can be cases where replication has failed or is no longer active and the replication destination volume group force needs to be cleaned up.
Name protection_po licy_id optional Description Schema Unique identifier of the protection policy to assign to a primary or clone volume group. If an empty string is specified, protection policy will be removed from the string volume group. volume_group_refresh Refresh volume group request.
volume_group_restore Restore volume group request. Name Description backup_snap_ Schema volume_group_snap profile shot optional This parameter specifies whether a backup snapshot set of create_backu the target volume group needs to be created before p_snap attempting restore. This parameter defaults to true, if not boolean optional specified. Default : true from_snap_id Unique identifier of the snapshot set to restore from. This is required referred to as the source volume group.
Name Schema id string optional volume_instance Details about a volume, including snapshots and clones of volumes. This resource type has queriable associations from appliance, policy, migration_session, host_volume_mapping, volume_group Name Description appliance This is the embeddable reference form of appliance_id optional attribute. appliance_id Unique identifier of the appliance on which the volume is optional provisioned.
Name location_histo ry optional mapped_volu mes optional migration_ses sion optional migration_ses sion_id optional Description Schema Filtering on the fields of this embedded resource is not supported. This is is location_history_inst ance > array the inverse of the resource type host_volume_mapping association. This < the embeddable < host_volume_mappi ng_instance > array reference form of migration_session_i migration_session_id attribute.
Name Description Schema Size of the volume in bytes. Minimum volume size is 1MB. size optional Maximum volume size is 256TB. Size must be a multiple of 8192.
Name Description Schema Normally a replication destination volume cannot be modified since it is controlled by replication. However, there can be cases where replication has failed or is no longer active and the replication destination volume needs force optional to be cleaned up.
Name Description Schema Profile for the backup snapshot. volume_snapshot backup_snap_ profile optional create_backu Indicates whether to create a backup snapshot of the p_snap volume before refreshing. optional Default : false from_object_i d required boolean Unique identifier of the source object of the refresh operation. The refresh operation only refreshes the data. string volume_refresh_response Unique identifier of the backup snapshot if one is created.
Name Schema backup_snapshot_id optional string volume_snapshot Name Description Schema creator_type StorageCreatorType optional Enum description optional Description of the snapshot. This value must contain 128 or fewer printable Unicode characters. string Maximal length : 128 Expiration time of the snapshot. Expired snapshots are expiration_ti deleted by the snapshot aging service that runs periodically mestamp in the background.
Name Description description Schema string optional error_code Minimum value : 0 optional Maximum value : 2147483647 integer (int32) wear_metrics_by_drive_instance Wear metrics for the drives collected at twenty second interval. Polymorphism : Inheritance Discriminator : entity Name Description drive_id Reference to the associated drive which these metrics were optional recorded.
Name Description Schema service X509CertificateServi required ceEnum x509_certificate_exchange x509 certificate exchange opertation request body. Name address required Description Schema Peer’s ip v4 or v6 address or dns name. string (ip-address) password Password required PowerStore cluster. port required used in basic authentication to remote string (password) Peer’s port number.
Name Description Member certificates included in this x509_certificate. members Member certificates should be remained in an ordered optional sequence. Filtering on the fields of this embedded resource is not supported.
