Last active
October 12, 2020 21:37
-
-
Save ody/df5d8be36f49d4b39e50150d12c98488 to your computer and use it in GitHub Desktop.
powerstore.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger" : "2.0", | |
| "info" : { | |
| "title" : "PowerStore REST API", | |
| "description" : "Storage cluster REST API definition.", | |
| "version" : "1.0", | |
| "license" : { | |
| "name" : "End User License Agreement", | |
| "url" : "/locales/en-US/eula.txt" | |
| } | |
| }, | |
| "host" : "10.119.0.150", | |
| "tags" : [ { | |
| "description" : "Use these resource types to manage events and alerts in the system.", | |
| "name" : "alert" | |
| }, { | |
| "description" : "Manage appliances", | |
| "name" : "appliance" | |
| }, { | |
| "description" : "Use this resource type to query audit log information.", | |
| "name" : "audit_event" | |
| }, { | |
| "description" : "Use these resource types to manage the cluster-wide configuration of virtual IP ports, bonds, and virtual Ethernet ports.\n", | |
| "name" : "bond" | |
| }, { | |
| "description" : "CHAP is enabled (or not) identically cluster-wide for all iSCSI targets. For both single and mutual CHAP authentication modes, the common username and password for all targets on the cluster are 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.", | |
| "name" : "chap_config" | |
| }, { | |
| "description" : "Manage clusters", | |
| "name" : "cluster" | |
| }, { | |
| "description" : "List initiators currently connected to the cluster that are not associated with an initiator group or host.", | |
| "name" : "discovered_initiator" | |
| }, { | |
| "description" : "Manage DNS and NTP settings for the cluster.", | |
| "name" : "dns" | |
| }, { | |
| "description" : "Use these resource types to configure outgoing SMTP and email notifications.", | |
| "name" : "email_notify_destination" | |
| }, { | |
| "description" : "This is the REST API for cluster-wide retrieval and configuration of Ethernet front-end ports.\n", | |
| "name" : "eth_port" | |
| }, { | |
| "description" : "Use these resource types to manage events and alerts in the system.", | |
| "name" : "event" | |
| }, { | |
| "description" : "Use this resource type to retrieve information about Fibre Channel (FC) front-end ports and to set their connection speeds.\n", | |
| "name" : "fc_port" | |
| }, { | |
| "description" : "Information about File network interfaces in the storage system. These interfaces control access to Windows (CIFS) and UNIX/Linux (NFS) file storage.", | |
| "name" : "file_interface" | |
| }, { | |
| "description" : "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. Storage systems support NDMP v2-v4 over the network. Direct-attach NDMP is not supported. This means that the tape drives need to be connected to a media server, and the NAS server communicates with the media server over the network. NDMP has an advantage when using multiprotocol file systems because it backs up the Windows ACLs as well as the UNIX security information.", | |
| "name" : "file_ndmp" | |
| }, { | |
| "description" : "Manage NAS file systems.", | |
| "name" : "file_system" | |
| }, { | |
| "description" : "Use these resource types to manage the virus checker service of a NAS server. A virus checker instance is created each time the anti-virus service is enabled on a NAS server. A configuration file (named viruschecker.conf) needs to be uploaded before enabling the anti-virus service.\nThe cluster supports third-party anti-virus servers that perform virus scans and reports back to the storage system. For example, when an SMB client creates, moves, or modifies a file, the NAS server invokes the anti-virus server to scan the file for known viruses. During the scan any access to this file is 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.\n", | |
| "name" : "file_virus_checker" | |
| }, { | |
| "description" : "This provides the hardware component inventory of the system.", | |
| "name" : "hardware" | |
| }, { | |
| "description" : "Manage hosts that access the cluster.", | |
| "name" : "host" | |
| }, { | |
| "description" : "Manage host groups.\n 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).", | |
| "name" : "host_group" | |
| }, { | |
| "description" : "Storage cluster REST API definition.", | |
| "name" : "host_volume_mapping" | |
| }, { | |
| "description" : "Virtual volume mapping details.", | |
| "name" : "host_virtual_volume_mapping" | |
| }, { | |
| "description" : "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.", | |
| "name" : "import_host_initiator" | |
| }, { | |
| "description" : "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. Also, import_host_system supports FC and ISCSI connections between Host and source arrays. So for a single import_host_system which supports both FC and ISCSI; there would be two Hosts entries for representing the FC and iSCSI connections.", | |
| "name" : "import_host_system" | |
| }, { | |
| "description" : "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.", | |
| "name" : "import_host_volume" | |
| }, { | |
| "description" : "Use these resource types to discover the Peer Storage Group (PS Group) volumes that can be imported to PowerStore.", | |
| "name" : "import_psgroup" | |
| }, { | |
| "description" : "Use these resource types to discover the Peer Storage Group (PS Group) volumes that can be imported to PowerStore.", | |
| "name" : "import_psgroup_volume" | |
| }, { | |
| "description" : "Use the import_session resource type to initiate and manage the migration of volumes and consistency groups from a heritage Dell EMC storage system to a PowerStore storage system. The import is non-disruptive to hosts that access the volume during the import. The import process runs as a background job. Clients should poll the job status until the import completes. Note: In these descriptions, LUNs are referred to as volumes and storage arrays are referred to as storage systems.", | |
| "name" : "import_session" | |
| }, { | |
| "description" : "Use these resource types to discover the Storage Center (SC) volumes and consistency groups that can be imported to PowerStore.", | |
| "name" : "import_storage_center" | |
| }, { | |
| "description" : "Use these resource types to discover the Storage Center (SC) volumes and consistency groups that can be imported to PowerStore.", | |
| "name" : "import_storage_center_consistency_group" | |
| }, { | |
| "description" : "Use these resource types to discover the Storage Center (SC) volumes that can be imported to PowerStore.", | |
| "name" : "import_storage_center_volume" | |
| }, { | |
| "description" : "Use this resource type to discover the Unity system that is a source storage system for import", | |
| "name" : "import_unity" | |
| }, { | |
| "description" : "Use this resource type to discover the Unity consistency groups that can be imported to PowerStore.", | |
| "name" : "import_unity_consistency_group" | |
| }, { | |
| "description" : "Use this resource type to discover the Unity volumes that can be imported to PowerStore.", | |
| "name" : "import_unity_volume" | |
| }, { | |
| "description" : "Use these resource types to discover the VNX storage system that can be imported to PowerStore.", | |
| "name" : "import_vnx_array" | |
| }, { | |
| "description" : "Use this resource type to show the VNX consistency groups that can be imported to PowerStore.", | |
| "name" : "import_vnx_consistency_group" | |
| }, { | |
| "description" : "Use this resource type to show the VNX volumes and that can be imported to PowerStore.", | |
| "name" : "import_vnx_volume" | |
| }, { | |
| "description" : "Use these resource types to scale and reconfigure the IP networks in a cluster.", | |
| "name" : "ip_pool_address" | |
| }, { | |
| "description" : "Use these resource types to manage the cluster-wide configuration of virtual IP ports, bonds, and virtual Ethernet ports.\n", | |
| "name" : "ip_port" | |
| }, { | |
| "description" : "Use this resource type for tracking an operation's progress and status.", | |
| "name" : "job" | |
| }, { | |
| "description" : "Use this resource to generate and download an encryption keystore archive file.", | |
| "name" : "keystore_archive" | |
| }, { | |
| "description" : "Use this resource type to view and manage the software license for the cluster. \n\nLicenses 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. \n\n\nWhen an appliance is added to the cluster, the process starts over, and the cluster license will need to be updated, either automatically, or manually if network connectivity to the Software Licensing Central is not available.\n\nIf the system lacks network connectivity to reach the Software Licensing Central, an alert will be raised that indicates when the trial period will expire. For sites that do not allow connection to the Software Licensing Central, there is an alternate mechanism to license the cluster:\n1. Get the license activation file from the system.\n2. Log on to the DellEMC Software Licensing Central as a customer and provide the activation file. You will receive a license file back.\n3. Upload the license file to the system.\n \n", | |
| "name" : "license" | |
| }, { | |
| "description" : "Use this resource type to manage local user accounts.", | |
| "name" : "local_user" | |
| }, { | |
| "description" : "Use these resource types to manage sessions, roles, and system security configurations.", | |
| "name" : "login_session" | |
| }, { | |
| "description" : "Use these resource types to manage sessions, roles, and system security configurations.", | |
| "name" : "logout" | |
| }, { | |
| "description" : "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. After the specified interval (1-48 hours), the maintenance window will get automatically disabled and any alerts that are still outstanding will generate notifications. Specifically, anything that would have generated a notification but didn't do so because of the maintenance window and that remains outstanding after the window closes, will result in a notification when the window is disabled.", | |
| "name" : "maintenance_window" | |
| }, { | |
| "name" : "metrics", | |
| "description" : "REST APIs Use these resource types to query historical metric data." | |
| }, { | |
| "description" : "The system produces migration recommendations periodically or upon request, based on capacity usage and recent performance. A recommendation can then be implemented using the create_migration_sessions action, performing any necessary rescans on attached hosts, and then using start_migration_sessions.", | |
| "name" : "migration_recommendation" | |
| }, { | |
| "description" : "Manage migration sessions.", | |
| "name" : "migration_session" | |
| }, { | |
| "description" : "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.", | |
| "name" : "nas_server" | |
| }, { | |
| "description" : "Use these resource types to scale and reconfigure the IP networks in a cluster.", | |
| "name" : "network" | |
| }, { | |
| "description" : "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.", | |
| "name" : "nfs_server" | |
| }, { | |
| "description" : "Use this resource type to retrieve information about nodes in a cluster.\n", | |
| "name" : "node" | |
| }, { | |
| "description" : "Manage DNS and NTP settings for the cluster.", | |
| "name" : "ntp" | |
| }, { | |
| "description" : "Information about performance rules that can be use in performance policies applied to volumes and volume groups.", | |
| "name" : "performance_rule" | |
| }, { | |
| "description" : "Manage physical switches settings for the cluster.", | |
| "name" : "physical_switch" | |
| }, { | |
| "description" : "Use this resource type to manage protection policies and to view information about performance policies.\n\nNote: Performance policies are predefined for high, low, and medium performance. They cannot be added to or changed.", | |
| "name" : "policy" | |
| }, { | |
| "description" : "Information about remote storage systems that connect to the local PowerStore system. The system uses the configuration to access and communicate with the remote system for management and data transfer communications. \nFor example, to use remote replication, create a configuration that specifies the remote system to use as the destination for the replication session.\n\nThe 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. \n**NOTE**\nBefore 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.\n", | |
| "name" : "remote_system" | |
| }, { | |
| "description" : "Use this resource type to manage the replication rules that are used in protection policies.", | |
| "name" : "replication_rule" | |
| }, { | |
| "description" : "Use this resource type to manage replication sessions for storage resources in the system. Replication sessions operate on volume and volume_group resource types. Replication sessions are created and deleted through protection policies on the storage resources.\n\n\n\nIn addition to copying data, the replication session synchronizes configuration changes on source resource and replicates user and scheduled snapshots to destination system. \n\n\n\nReplication sessions provide disaster recovery failover, reprotect and failback capabilities. As a result:\n* The downtime-associated cost of a system failure is minimized.\n* The recovery process from a disaster is facilitated.\n\n\n\nReplication sessions also provides pause and resume capabilities, to allow for production or disaster recovery-side maintenance requirements.\n\n\n\nDestination 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.\n\n\n\nOn the source end, volumes can be expanded, and volume group membership changes are allowed during any states of a replication session. \n\n\n", | |
| "name" : "replication_session" | |
| }, { | |
| "description" : "Use these resource types to manage sessions, roles, and system security configurations.", | |
| "name" : "role" | |
| }, { | |
| "description" : "Use this resource type to retrieve information about SAS ports.\n", | |
| "name" : "sas_port" | |
| }, { | |
| "description" : "system security configuration", | |
| "name" : "security_config" | |
| }, { | |
| "description" : "Manage the service configuration for each appliance. \n * 'SSH Access' - Manage the ability for the service user to remotely connect to the nodes in an appliance using SSH.", | |
| "name" : "service_config" | |
| }, { | |
| "description" : "Use this resource type to manage the service user account.\nThe 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. You cannot create more service user accounts or delete the default service user account. During the intial configuration, along with the default admin user account, a password change for the service user account is also required.\n\n\n Only the default service_user account can log in via SSH. Ensure that SSH is enabled on the system for the service_user to log in. SSH can be enabled or disabled using the service_config modify operation.", | |
| "name" : "service_user" | |
| }, { | |
| "description" : "Use these resource types to manage Server Message Block (SMB) servers. SMB is a protocol for sharing files and communications abstractions such as named pipes and mail slots between computers. Most usage of SMB involves computers running Microsoft Windows, but it is commonly supported on other types of systems as well. SMB was formerly known as Common Internet File System (CIFS). \nAn SMB server must be created on a NAS server before SMB shares can be created on the file systems on that NAS server. An SMB server can be created as a standalone server or as a server that belongs to an Active Directory domain (often a Window domain). In that case, DNS must be enabled on the NAS server. The credentials of an administrator of the domain are required to join that domain. An NTP server must be defined also, to prevent authentication errors caused by unsynchronized clocks. Each NAS server supports a maximum of one SMB server.\n", | |
| "name" : "smb_server" | |
| }, { | |
| "description" : "SMB Shares use the SMB protocol to provide an access point for configured Windows hosts to access file system storage. The system uses Active Directory to authenticate user and user group access to the Share.", | |
| "name" : "smb_share" | |
| }, { | |
| "description" : "Use these resource types to configure outgoing SMTP and email notifications.", | |
| "name" : "smtp_config" | |
| }, { | |
| "description" : "Use this resource type to manage snapshot rules that are used in protection policies.", | |
| "name" : "snapshot_rule" | |
| }, { | |
| "description" : "Software upgrade functionality. Only one upgrade can be active at a time.", | |
| "name" : "software_installed" | |
| }, { | |
| "description" : "Software upgrade functionality. Only one upgrade can be active at a time.", | |
| "name" : "software_package" | |
| }, { | |
| "description" : "Manage storage containers. A storage container is a logical grouping of related storage objects in a cluster. A storage container corresponds to a vVol datastore in vCenter and is used to group related vVols and track the amount of space that is used/free.", | |
| "name" : "storage_container" | |
| }, { | |
| "description" : "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. For Unified deployments, one external vCenter may be configured if desired.", | |
| "name" : "vcenter" | |
| }, { | |
| "description" : "Use these resource types to manage the cluster-wide configuration of virtual IP ports, bonds, and virtual Ethernet ports.\n", | |
| "name" : "veth_port" | |
| }, { | |
| "description" : "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.", | |
| "name" : "virtual_machine" | |
| }, { | |
| "description" : "Information about virtual volumes, which are managed through vCenter.", | |
| "name" : "virtual_volume" | |
| }, { | |
| "description" : "Manage volumes, including snapshots and clones of volumes.", | |
| "name" : "volume" | |
| }, { | |
| "description" : "Manage volume_groups. A volume_group is a group of related volumes treated as a single unit. It can optionally be write-order consistent.", | |
| "name" : "volume_group" | |
| }, { | |
| "description" : "Use these resource types to manage SSL/TLS certificates. The X509 Certificate service is part of the credential store services. An X509 Certificate in this service represents a certificate chain, composed of the certificate of each individual member in ordered sequence. If the X509 Certificate is used as a server certificate or client certificate, it also includes the private key.", | |
| "name" : "x509_certificate" | |
| }, { | |
| "description" : "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.\n", | |
| "name" : "nfs_export" | |
| }, { | |
| "description" : "Tree quota settings in the storage system. A tree quota instance represents a quota limit applied to a specific directory tree in a file system.", | |
| "name" : "file_tree_quota" | |
| }, { | |
| "description" : "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.", | |
| "name" : "file_user_quota" | |
| }, { | |
| "description" : "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. A DNS is a hierarchical system responsible for converting domain names to their corresponding IP addresses. A NAS server\\'s DNS settings should allow DNS resolution of all names within an SMB server\\'s domain in order for the SMB protocol to operate normally within an Active Directory domain. The DNS default port is 53.", | |
| "name" : "file_dns" | |
| }, { | |
| "description" : "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. By default when an FTP server is created, the unsecure service will be running. FTP is a standard network protocol used to transfer files from one host to another host over a TCP-based network, such as the Internet. For secure transmission that encrypts the username, password, and content, FTP is secured with SSH (SFTP). SFTP listens on port 22.\nYou can activate an FTP server and SFTP server independently on each NAS server. The FTP and SFTP clients are authenticated using credentials defined on a Unix name server (such as an NIS server or an LDAP server) or a Windows domain. Windows user names need to be entered using the 'username@domain' or 'domain\\\\username' formats. Each secure and unsecure service must have a home directory defined in the name server that must be accessible on the NAS server. FTP also allows clients to connect as anonymous users. \n", | |
| "name" : "file_ftp" | |
| }, { | |
| "description" : "Use these resources to manage static IP routes, including creating, modifying, and deleting these routes.\n\nA route determines where to send a packet next so it can reach its final destination. A static route is set explicitly and does not automatically adapt to the changing network infrastructure. A route is defined by an interface, destination IP address range and an IP address of a corresponding gateway.\n\n**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.\n", | |
| "name" : "file_interface_route" | |
| }, { | |
| "description" : "Use these resources to manage the Kerberos service for a NAS server. One Kerberos service object may be configured per NAS Server. Kerberos is a distributed authentication service designed to provide strong authentication with secret-key cryptography. It works on the basis of \"tickets\" that allow nodes communicating over a non-secure network to prove their identity in a secure manner. When configured to act as a secure NFS server, the NAS Server uses the RPCSEC_GSS security 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.", | |
| "name" : "file_kerberos" | |
| }, { | |
| "description" : "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. A NAS Server can use LDAP as a Unix Directory Service to map users, retrieve netgroups, and build a Unix credential. When an initial LDAP configuration is applied, the system checks for the type of LDAP server. It can be an Active Directory schema or an RFC 2307 schema.", | |
| "name" : "file_ldap" | |
| }, { | |
| "description" : "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.", | |
| "name" : "file_nis" | |
| } ], | |
| "x-categories" : { | |
| "Compute" : { | |
| "description" : "Manage host configurations, virtual machines and VMware integration", | |
| "tags" : [ "host", "host_group", "host_volume_mapping", "host_virtual_volume_mapping", "discovered_initiator", "vcenter", "virtual_machine" ] | |
| }, | |
| "Migration" : { | |
| "description" : "Manage data import and data migration from remote systems", | |
| "tags" : [ "import_host_initiator", "import_host_system", "import_host_volume", "import_psgroup", "import_psgroup_volume", "import_session", "import_storage_center", "import_storage_center_consistency_group", "import_storage_center_volume", "import_unity", "import_unity_consistency_group", "import_unity_volume", "import_vnx_array", "import_vnx_consistency_group", "import_vnx_volume", "migration_recommendation", "migration_session" ] | |
| }, | |
| "Monitoring" : { | |
| "description" : "View event logs and alerts", | |
| "tags" : [ "alert", "event", "job", "metrics" ] | |
| }, | |
| "Protection" : { | |
| "description" : "Manage replication and data protection rules", | |
| "tags" : [ "policy", "remote_system", "replication_rule", "replication_session", "snapshot_rule" ] | |
| }, | |
| "Settings" : { | |
| "description" : "Configure general settings on the system including:\n* Networking\n* Licensing\n* Updates\n", | |
| "tags" : [ "license", "logout", "software_installed", "software_package", "email_notify_destination", "chap_config", "local_user", "login_session", "keystore_archive", "role", "security_config", "x509_certificate", "audit_event", "ip_pool_address", "ip_port", "network", "ntp", "dns", "smtp_config", "physical_switch" ] | |
| }, | |
| "Storage" : { | |
| "description" : "Storage configuration of the system:\n* Create delete storage resources\n* Configure NAS servers\n", | |
| "tags" : [ "storage_container", "virtual_volume", "volume", "nas_server", "nfs_server", "smb_server", "file_interface", "file_ndmp", "file_virus_checker", "performance_rule", "file_system", "smb_share", "volume_group", "file_tree_quota", "file_user_quota", "file_dns", "file_ftp", "file_interface_route", "file_kerberos", "file_ldap", "file_nis", "nfs_export" ] | |
| }, | |
| "Support" : { | |
| "description" : "Manage service user credentials, perform service actions on the system", | |
| "tags" : [ "service_config", "service_user", "maintenance_window" ] | |
| }, | |
| "System and Hardware" : { | |
| "description" : "Manage hardware, view component health status, change cluster configuration", | |
| "tags" : [ "appliance", "cluster", "node", "hardware", "eth_port", "fc_port", "sas_port", "veth_port", "bond" ] | |
| } | |
| }, | |
| "schemes" : [ "https" ], | |
| "basePath" : "/api/rest", | |
| "produces" : [ "application/json" ], | |
| "consumes" : [ "application/json" ], | |
| "paths" : { | |
| "/appliance" : { | |
| "get" : { | |
| "tags" : [ "appliance" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query the appliances in a cluster.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/appliance_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of appliance instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/appliance_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/appliance/{id}" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the appliance.", | |
| "x-ref" : "appliance" | |
| } ], | |
| "get" : { | |
| "tags" : [ "appliance" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific appliance in a cluster.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/appliance_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "appliance" ], | |
| "summary" : "Modify", | |
| "description" : "Modify an appliance's name.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/appliance_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Argument", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/node" : { | |
| "get" : { | |
| "tags" : [ "node" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query the nodes in a cluster.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/node_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of node instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/node_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/node/{id}" : { | |
| "get" : { | |
| "tags" : [ "node" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific node in a cluster.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the node.", | |
| "x-ref" : "node" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/node_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/network" : { | |
| "get" : { | |
| "tags" : [ "network" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query the IP network configurations of the cluster.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/network_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of network instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/network_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/network/{id}" : { | |
| "get" : { | |
| "tags" : [ "network" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific IP network configuration.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the IP network.", | |
| "x-ref" : "network" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/network_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "network" ], | |
| "summary" : "Modify", | |
| "description" : "Modify IP network parameters, such as gateways, netmasks, VLAN identifiers, and IP addresses.\n", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the IP network.", | |
| "x-ref" : "network" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/network_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/network/{id}/replace" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the IP network.", | |
| "x-ref" : "network" | |
| } ], | |
| "post" : { | |
| "tags" : [ "network" ], | |
| "summary" : "Reconfigure cluster management network settings from IPv4 to IPv6 or vice versa.", | |
| "operationId" : "replace", | |
| "description" : "Reconfigure cluster management network settings from IPv4 to IPv6 or vice versa.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/network_replace" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/network/{id}/scale" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the IP network.", | |
| "x-ref" : "network" | |
| } ], | |
| "post" : { | |
| "tags" : [ "network" ], | |
| "summary" : "Add or remove IP ports", | |
| "description" : "Add IP ports for use by the storage network, or remove IP ports so they can no longer be used.\nAt least one IP port must be configured for use by the storage network.\n", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/network_scale" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/ip_pool_address" : { | |
| "get" : { | |
| "tags" : [ "ip_pool_address" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query configured IP addresses.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ip_pool_address_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of ip pool address instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ip_pool_address_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/ip_pool_address/{id}" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of a configured IP address.", | |
| "x-ref" : "ip_pool_address" | |
| } ], | |
| "get" : { | |
| "tags" : [ "ip_pool_address" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific IP address.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/ip_pool_address_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/dns" : { | |
| "get" : { | |
| "tags" : [ "dns" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query DNS settings for a cluster.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/dns_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of dns instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/dns_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/dns/{id}" : { | |
| "get" : { | |
| "tags" : [ "dns" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific DNS setting.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the DNS setting.", | |
| "x-ref" : "dns" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/dns_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "dns" ], | |
| "summary" : "Modify", | |
| "description" : "Modify a DNS setting.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the DNS setting.", | |
| "x-ref" : "dns" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/dns_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/ntp" : { | |
| "get" : { | |
| "tags" : [ "ntp" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query NTP settings for a cluster.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ntp_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of ntp instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ntp_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/ntp/{id}" : { | |
| "get" : { | |
| "tags" : [ "ntp" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific NTP setting.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NTP setting.", | |
| "x-ref" : "ntp" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/ntp_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "ntp" ], | |
| "summary" : "Modify", | |
| "description" : "Modify NTP settings.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NTP setting.", | |
| "x-ref" : "ntp" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ntp_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/ip_port" : { | |
| "get" : { | |
| "tags" : [ "ip_port" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query IP port configurations.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ip_port_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of ip port instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ip_port_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/ip_port/{id}" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the IP port.", | |
| "x-ref" : "ip_port" | |
| } ], | |
| "get" : { | |
| "tags" : [ "ip_port" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific IP port configuration.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/ip_port_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "ip_port" ], | |
| "summary" : "Modify", | |
| "description" : "Modify IP port parameters.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/ip_port_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/physical_switch" : { | |
| "get" : { | |
| "tags" : [ "physical_switch" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query physical switches settings for a cluster.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/physical_switch_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of physical switch instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/physical_switch_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "physical_switch" ], | |
| "summary" : "Create", | |
| "description" : "Create a physical switch settings.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/physical_switch_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/physical_switch/{id}" : { | |
| "get" : { | |
| "tags" : [ "physical_switch" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific physical switch settings.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "minLength" : 1, | |
| "maxLength" : 32, | |
| "description" : "Unique identifier of the physical switch settings.", | |
| "x-ref" : "physical_switch" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/physical_switch_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "physical_switch" ], | |
| "summary" : "Modify", | |
| "description" : "Modify a physical switch settings.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "minLength" : 1, | |
| "maxLength" : 32, | |
| "description" : "Unique identifier of the physical switch settings.", | |
| "x-ref" : "physical_switch" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/physical_switch_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "physical_switch" ], | |
| "summary" : "Delete", | |
| "description" : "Delete the physical switch settings.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the physical switch settings.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "physical_switch" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/bond" : { | |
| "get" : { | |
| "tags" : [ "bond" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query bond configurations.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/bond_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of bond instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/bond_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/bond/{id}" : { | |
| "get" : { | |
| "tags" : [ "bond" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific bond configuration.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the bond configuration.", | |
| "x-ref" : "bond" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/bond_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/veth_port" : { | |
| "get" : { | |
| "tags" : [ "veth_port" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query virtual Ethernet port configurations.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/veth_port_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of veth port instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/veth_port_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/veth_port/{id}" : { | |
| "get" : { | |
| "tags" : [ "veth_port" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific virtual Ethernet port configuration.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the virtual Ethernet port.", | |
| "x-ref" : "veth_port" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/veth_port_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/metrics/generate" : { | |
| "post" : { | |
| "tags" : [ "metrics" ], | |
| "summary" : "Metrics", | |
| "description" : "Retrieves metrics for specified type.", | |
| "produces" : [ "application/json" ], | |
| "x-format_cli" : true, | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/metrics_generate" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| } | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/storage_container" : { | |
| "get" : { | |
| "tags" : [ "storage_container" ], | |
| "summary" : "Collection Query", | |
| "description" : "List storage containers.", | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/storage_container_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of storage container instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/storage_container_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "storage_container" ], | |
| "summary" : "Create", | |
| "description" : "Create a virtual volume (vVol) storage container.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/storage_container_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/storage_container/{id}" : { | |
| "get" : { | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Storage container ID.", | |
| "x-ref" : "storage_container" | |
| } ], | |
| "tags" : [ "storage_container" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific instance of storage container.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/storage_container_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "storage_container" ], | |
| "summary" : "Modify", | |
| "description" : "Modify a storage container.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Storage container ID.", | |
| "x-ref" : "storage_container" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "description" : "Fields to update.", | |
| "schema" : { | |
| "$ref" : "#/definitions/storage_container_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "storage_container" ], | |
| "summary" : "Delete", | |
| "produces" : [ "application/json" ], | |
| "description" : "Delete a storage container.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Storage container ID.", | |
| "x-ref" : "storage_container" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : false, | |
| "description" : "Options to delete storage_container.", | |
| "schema" : { | |
| "$ref" : "#/definitions/storage_container_delete" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/storage_container/{id}/mount" : { | |
| "post" : { | |
| "tags" : [ "storage_container" ], | |
| "summary" : "Mount", | |
| "description" : "Mount a storage container as a vVol datastore in vCenter.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Storage container ID.", | |
| "x-ref" : "storage_container" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/storage_container_mount" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/storage_container/{id}/unmount" : { | |
| "post" : { | |
| "tags" : [ "storage_container" ], | |
| "summary" : "Unmount", | |
| "description" : "Unmount a storage container, which removes the vVol datastore from vCenter.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Storage container ID.", | |
| "x-ref" : "storage_container" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/audit_event" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query audit log entries.", | |
| "tags" : [ "audit_event" ], | |
| "operationId" : "getAuditLogs", | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "OK", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/audit_event_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of audit event instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/audit_event_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/alert" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query all alerts.", | |
| "tags" : [ "alert" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/alert_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of alert instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/alert_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/alert/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific alert.", | |
| "tags" : [ "alert" ], | |
| "parameters" : [ { | |
| "description" : "Unique identifier of the alert.", | |
| "in" : "path", | |
| "name" : "id", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "alert" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/alert_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "summary" : "Modify", | |
| "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.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "required" : true, | |
| "in" : "path", | |
| "name" : "id", | |
| "type" : "string", | |
| "description" : "Unique identifier of the specific alert.", | |
| "x-ref" : "alert" | |
| }, { | |
| "name" : "alert_modify", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/alert_modify" | |
| } | |
| } ], | |
| "tags" : [ "alert" ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/event" : { | |
| "get" : { | |
| "description" : "Returns all events in the database.", | |
| "operationId" : "EventInstancesGet", | |
| "responses" : { | |
| "200" : { | |
| "description" : "An array of events", | |
| "schema" : { | |
| "items" : { | |
| "$ref" : "#/definitions/event_instance" | |
| }, | |
| "type" : "array" | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of event instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/event_instance" | |
| } | |
| } | |
| } | |
| }, | |
| "summary" : "Get events", | |
| "tags" : [ "event" ] | |
| } | |
| }, | |
| "/event/{id}" : { | |
| "get" : { | |
| "description" : "Get event by Event Id.", | |
| "operationId" : "EventInstanceGet", | |
| "parameters" : [ { | |
| "description" : "Event Id", | |
| "in" : "path", | |
| "name" : "id", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "event" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Event Object", | |
| "schema" : { | |
| "$ref" : "#/definitions/event_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| }, | |
| "summary" : "Event summary", | |
| "tags" : [ "event" ] | |
| } | |
| }, | |
| "/email_notify_destination" : { | |
| "get" : { | |
| "tags" : [ "email_notify_destination" ], | |
| "description" : "Query all email notification destinations.", | |
| "summary" : "Collection Query", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/email_notify_destination_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of email notify destination instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/email_notify_destination_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "email_notify_destination" ], | |
| "summary" : "Create", | |
| "description" : "Add an email address to receive notifications.", | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "body", | |
| "description" : "Email address to receive notifications.", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/email_notify_destination_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/email_notify_destination/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific email notification destination.", | |
| "parameters" : [ { | |
| "description" : "Unique identifier of the email notification destination.", | |
| "in" : "path", | |
| "name" : "id", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "email_notify_destination" | |
| } ], | |
| "tags" : [ "email_notify_destination" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/email_notify_destination_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "summary" : "Modify", | |
| "description" : "Modify an email notification destination.", | |
| "parameters" : [ { | |
| "description" : "Unique identifier of the email notification destination.", | |
| "type" : "string", | |
| "in" : "path", | |
| "name" : "id", | |
| "required" : true, | |
| "x-ref" : "email_notify_destination" | |
| }, { | |
| "description" : "Email address to receive notifications.", | |
| "in" : "body", | |
| "name" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/email_notify_destination_modify" | |
| } | |
| } ], | |
| "tags" : [ "email_notify_destination" ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "summary" : "Delete", | |
| "description" : "Delete an email notification destination.", | |
| "parameters" : [ { | |
| "description" : "Unique identifier of the email notification destination.", | |
| "type" : "string", | |
| "in" : "path", | |
| "name" : "id", | |
| "required" : true, | |
| "x-ref" : "email_notify_destination" | |
| } ], | |
| "tags" : [ "email_notify_destination" ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/email_notify_destination/{id}/test" : { | |
| "post" : { | |
| "tags" : [ "email_notify_destination" ], | |
| "summary" : "Test", | |
| "description" : "Send a test email to an email address.", | |
| "parameters" : [ { | |
| "description" : "Unique identifier of the email notification destination.", | |
| "type" : "string", | |
| "in" : "path", | |
| "name" : "id", | |
| "required" : true, | |
| "x-ref" : "email_notify_destination" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/smtp_config" : { | |
| "get" : { | |
| "tags" : [ "smtp_config" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query the SMTP configuration. There is always exactly one smtp_config instance.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/smtp_config_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of smtp config instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/smtp_config_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/smtp_config/{id}" : { | |
| "get" : { | |
| "parameters" : [ { | |
| "description" : "Unique identifier of the SMTP configuration.", | |
| "type" : "string", | |
| "in" : "path", | |
| "name" : "id", | |
| "required" : true, | |
| "x-ref" : "smtp_config" | |
| } ], | |
| "tags" : [ "smtp_config" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query the specific SMTP configuration.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/smtp_config_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "parameters" : [ { | |
| "description" : "Unique identifier of the SMTP configuration.", | |
| "type" : "string", | |
| "in" : "path", | |
| "name" : "id", | |
| "required" : true, | |
| "x-ref" : "smtp_config" | |
| }, { | |
| "in" : "body", | |
| "name" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/smtp_config_modify" | |
| } | |
| } ], | |
| "tags" : [ "smtp_config" ], | |
| "summary" : "Modify", | |
| "description" : "Configure the outgoing SMTP information.", | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/smtp_config/{id}/test" : { | |
| "post" : { | |
| "tags" : [ "smtp_config" ], | |
| "summary" : "Test", | |
| "description" : "Test the SMTP configuration.", | |
| "parameters" : [ { | |
| "description" : "Unique identifier of the SMTP configuration.", | |
| "type" : "string", | |
| "in" : "path", | |
| "name" : "id", | |
| "required" : true, | |
| "x-ref" : "smtp_config" | |
| }, { | |
| "description" : "Test operation request body.", | |
| "in" : "body", | |
| "name" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/smtp_config_test" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/performance_rule" : { | |
| "get" : { | |
| "tags" : [ "performance_rule" ], | |
| "summary" : "Collection query", | |
| "description" : "Get performance rules.", | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "OK", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/performance_rule_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of performance rule instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/performance_rule_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/performance_rule/{id}" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Performance Rule id.", | |
| "x-ref" : "performance_rule" | |
| } ], | |
| "get" : { | |
| "tags" : [ "performance_rule" ], | |
| "summary" : "Instance query", | |
| "description" : "Get a performance rule by id.", | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "OK", | |
| "schema" : { | |
| "$ref" : "#/definitions/performance_rule_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "The performance_rule does not exist.", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/maintenance_window" : { | |
| "get" : { | |
| "tags" : [ "maintenance_window" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query the maintenance window configurations.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/maintenance_window_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of maintenance window instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/maintenance_window_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/maintenance_window/{id}" : { | |
| "get" : { | |
| "parameters" : [ { | |
| "description" : "Unique identifier of the maintenance window configuration.", | |
| "type" : "string", | |
| "in" : "path", | |
| "name" : "id", | |
| "required" : true, | |
| "x-ref" : "maintenance_window" | |
| } ], | |
| "tags" : [ "maintenance_window" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query one appliance maintenance window configuration.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/maintenance_window_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "parameters" : [ { | |
| "description" : "Unique identifier of the maintenance window configuration.", | |
| "type" : "string", | |
| "in" : "path", | |
| "name" : "id", | |
| "required" : true, | |
| "x-ref" : "maintenance_window" | |
| }, { | |
| "in" : "body", | |
| "name" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/maintenance_window_modify" | |
| } | |
| } ], | |
| "tags" : [ "maintenance_window" ], | |
| "summary" : "Modify", | |
| "description" : "Configure maintenance window.", | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/appliance/{id}/forecast" : { | |
| "post" : { | |
| "tags" : [ "appliance" ], | |
| "description" : "Forecast capacity usage for an appliance.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique id of the appliance.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "appliance" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/appliance_forecast" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/appliance_forecast_response" | |
| } | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/appliance/{id}/time_to_full" : { | |
| "post" : { | |
| "tags" : [ "appliance" ], | |
| "description" : "Returns information about when an appliance is forecast to reach 100% capacity usage.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique id of the appliance.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "appliance" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/appliance_time_to_full" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/appliance_time_to_full_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/cluster" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Get details about the cluster. \nThis resource type collection query does not support filtering, sorting or pagination", | |
| "tags" : [ "cluster" ], | |
| "x-simple_get" : true, | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/cluster_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of cluster instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/cluster_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/cluster/{id}" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the Cluster.", | |
| "x-ref" : "cluster" | |
| } ], | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Get details about the cluster. This does not support the following standard query functionality: property selection, and nested query embedding.", | |
| "tags" : [ "cluster" ], | |
| "x-simple_get" : true, | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "ID of the cluster.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "cluster" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/cluster_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "cluster" ], | |
| "summary" : "Modify cluster properties", | |
| "description" : "Modify cluster properties, such as physical MTU.\n", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the cluster.", | |
| "x-ref" : "cluster" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/cluster_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/cluster/{id}/forecast" : { | |
| "post" : { | |
| "tags" : [ "cluster" ], | |
| "description" : "Forecast capacity usage for the cluster.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique id of the cluster.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "cluster" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/cluster_forecast" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/cluster_forecast_response" | |
| } | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/cluster/{id}/time_to_full" : { | |
| "post" : { | |
| "tags" : [ "cluster" ], | |
| "description" : "Returns information about when the cluster is forecast to reach 100% capacity usage.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique id of the cluster", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "cluster" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/cluster_time_to_full" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Successful operation.", | |
| "schema" : { | |
| "$ref" : "#/definitions/cluster_time_to_full_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/fc_port" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query the FC front-end port configurations for all cluster nodes.", | |
| "tags" : [ "fc_port" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/fc_port_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of fc port instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/fc_port_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/fc_port/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific FC front-end port configuration.", | |
| "tags" : [ "fc_port" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the FC front-end port.", | |
| "x-ref" : "fc_port" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/fc_port_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "summary" : "Modify", | |
| "description" : "Modify an FC front-end port's speed. Setting the port's requested speed might not cause the port speed to change immediately. In cases where the Small Form-Factor Pluggable (SFP) is not inserted or the port is down, the requested speed is set, but the current_speed attribute shows the old value until the SFP is able to change speed. By default, the partner port speed on the other node in the appliance is set to the same requested speed. If the requested speed is not supported by the partner port, it is left unchanged.", | |
| "tags" : [ "fc_port" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the FC front-end port.", | |
| "x-ref" : "fc_port" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/fc_port_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request.", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/sas_port" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query the SAS port configuration for all cluster nodes.", | |
| "tags" : [ "sas_port" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/sas_port_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of sas port instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/sas_port_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/sas_port/{id}" : { | |
| "get" : { | |
| "summary" : "Instance query", | |
| "description" : "Query a specific SAS port configuration.", | |
| "tags" : [ "sas_port" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the SAS port.", | |
| "x-ref" : "sas_port" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/sas_port_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/eth_port" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Get Ethernet front-end port configuration for all cluster nodes.", | |
| "tags" : [ "eth_port" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/eth_port_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of eth port instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/eth_port_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/eth_port/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Get Ethernet front-end port configuration by instance identifier.", | |
| "tags" : [ "eth_port" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Ethernet front-end port instance identifier.", | |
| "x-ref" : "eth_port" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/eth_port_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "summary" : "Modify", | |
| "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. By default, the partner port speed on the other node in the appliance is set to the same requested speed. If the requested speed is not supported by the partner port it is left unchanged.", | |
| "tags" : [ "eth_port" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the port.", | |
| "x-ref" : "eth_port" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/eth_port_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/keystore_archive/regenerate" : { | |
| "post" : { | |
| "summary" : "Regenerate archive file", | |
| "description" : "Creates a new encryption keystore archive file to replace the existing archive file, which includes the individual keystore backup files from each appliance in the cluster. Once complete, the command response includes a Uniform Resource Identifier, which can be used in a subsequent GET request to download the keystore backup archive file. This request is valid only on systems where Data at Rest Encryption is enabled and is applicable only on systems that support Data at Rest Encryption.", | |
| "tags" : [ "keystore_archive" ], | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/keystore_archive_regenerate_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/keystore_archive/{filename}" : { | |
| "get" : { | |
| "summary" : "Download a keystore backup archive file", | |
| "description" : "Download a keystore backup archive file that was previously generated by a successful /api/rest/keystore_archive/regenerate POST command. \nThis resource type collection query does not support filtering, sorting or pagination", | |
| "tags" : [ "keystore_archive" ], | |
| "x-simple_get" : true, | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/zip" ], | |
| "parameters" : [ { | |
| "name" : "filename", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Filename is the last component in the URI path and becomes the filename of the downloaded file." | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/keystore_archive_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found.", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/software_installed" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query the software that is installed on each appliance. The output returns a list of JSON objects representing the software that is installed on each appliance and one entry representing the common software installed version that is supported for all appliances in the cluster.", | |
| "tags" : [ "software_installed" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/software_installed_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of software installed instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/software_installed_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/software_installed/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific item from the list of installed software.", | |
| "tags" : [ "software_installed" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the installed software to query.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "software_installed" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/software_installed_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/software_package" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query the software packages that are known by the cluster. The output returns a list of JSON objects representing the packages.", | |
| "tags" : [ "software_package" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success.", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/software_package_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of software package instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/software_package_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "summary" : "Upload", | |
| "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.", | |
| "consumes" : [ "multipart/form-data" ], | |
| "produces" : [ "application/json" ], | |
| "tags" : [ "software_package" ], | |
| "parameters" : [ { | |
| "in" : "formData", | |
| "name" : "upload_file", | |
| "type" : "file", | |
| "description" : "Name of the software package file to upload." | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/software_package/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific software package.", | |
| "tags" : [ "software_package" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the software package to query.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "software_package" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/software_package_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "summary" : "Delete", | |
| "description" : "Delete the specified software package from the cluster. This operation may take some time to complete.", | |
| "tags" : [ "software_package" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the software package to delete.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "software_package" | |
| } ], | |
| "responses" : { | |
| "202" : { | |
| "description" : "Accepted", | |
| "schema" : { | |
| "$ref" : "#/definitions/job_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/software_package/{id}/install" : { | |
| "post" : { | |
| "summary" : "Start Upgrade", | |
| "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.\n\n\n\nOnly specify a subset of appliances to upgrade if the time required to upgrade the entire cluster does not fit within a desired maintenance window. When upgrading a subset of appliances, you must adhere to the following ordering rules:\n\n\n\n* The primary appliance must always be upgraded first.\n* The secondary appliance, which is used as the cluster management database fail-over target, must be upgraded second.\n* After the primary and secondary appliances are upgraded, any remaining appliances in the cluster may be upgraded. By default, the process upgrades the appliances in the order they were added to the cluster if possible.\n\n\n\nBecause this operation takes a long time to complete, using the \"is_async flag\" is recommended. If the \"is_reboot_required\" flag is set to true, the primary appliance reboots before the install completes and the operation cannot return synchronously.\n", | |
| "tags" : [ "software_package" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the instance.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "software_package" | |
| }, { | |
| "in" : "body", | |
| "name" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/software_package_install" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/software_package/{id}/puhc" : { | |
| "post" : { | |
| "summary" : "Pre-upgrade Health Check", | |
| "description" : "Run the pre-upgrade health check for a software package. This operation may take some time to respond.", | |
| "tags" : [ "software_package" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the software package.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "software_package" | |
| }, { | |
| "in" : "body", | |
| "name" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/software_package_install" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/migration_session" : { | |
| "get" : { | |
| "description" : "Query migration sessions.", | |
| "summary" : "Collection Query", | |
| "tags" : [ "migration_session" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/migration_session_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "summary" : "Create", | |
| "description" : "Create a new migration session. For virtual volumes (vVols), the background copy is completed during this phase and the ownership of the vVol is transferred to the new appliance. For volumes and application groups, a migration session is created in this phase and no background copy is performed until either the sync or cutover operation is invoked. There are no interruptions to any services during this phase.", | |
| "tags" : [ "migration_session" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "description" : "Parameters to create a migration session.", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/migration_session_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/migration_session_create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/migration_session/{id}" : { | |
| "get" : { | |
| "description" : "Query a specific migration session.", | |
| "summary" : "Instance Query", | |
| "tags" : [ "migration_session" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the migration session.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "migration_session" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/migration_session_instance" | |
| } | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "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.", | |
| "summary" : "Delete", | |
| "tags" : [ "migration_session" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the migration session.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "migration_session" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "description" : "Parameters for a deletion.", | |
| "required" : false, | |
| "schema" : { | |
| "$ref" : "#/definitions/migration_session_delete" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/migration_session/{id}/pause" : { | |
| "post" : { | |
| "summary" : "Pause", | |
| "description" : "Pause a migration session. Only migration sessions in the synchronizing state can be paused.", | |
| "tags" : [ "migration_session" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the migration session.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "migration_session" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/migration_session/{id}/resume" : { | |
| "post" : { | |
| "summary" : "Resume", | |
| "description" : "Resume a paused migration session. You cannot resume a migration session in the failed state.", | |
| "tags" : [ "migration_session" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the migration session.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "migration_session" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/migration_session/{id}/sync" : { | |
| "post" : { | |
| "summary" : "Sync", | |
| "description" : "Synchronize a migration session. During this phase, the majority of the background copy is completed and there are no interruptions to any services. Sync can be run multiple times to reduce the amount of data that must be copied during the cutover.", | |
| "tags" : [ "migration_session" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the migration session.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "migration_session" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "description" : "Parameters for synchronizing a migration session.", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/migration_session_sync" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/migration_session/{id}/cutover" : { | |
| "post" : { | |
| "summary" : "Cutover", | |
| "description" : "Final phase of the migration, when ownership of the volume, vVol, or volume group is transferred to the new appliance.", | |
| "tags" : [ "migration_session" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the migration session.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "migration_session" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/service_config" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query the service configuration instances for the cluster. \nThis resource type collection query does not support filtering, sorting or pagination", | |
| "x-simple_get" : true, | |
| "tags" : [ "service_config" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/service_config_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of service config instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/service_config_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/service_config/{id}" : { | |
| "parameters" : [ { | |
| "description" : "Unique identifier of the instance.", | |
| "in" : "path", | |
| "name" : "id", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "service_config" | |
| } ], | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Query the service configuration instances for an appliance.", | |
| "x-simple_get" : true, | |
| "tags" : [ "service_config" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/service_config_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "summary" : "Modify", | |
| "description" : "Modify the service configuration for an appliance.", | |
| "tags" : [ "service_config" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/service_config_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/policy" : { | |
| "get" : { | |
| "description" : "Query protection and performance policies.\n\nThe following REST query is an example of how to retrieve protection policies along with their rules and associated resources:\n\nhttps://{{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,name)&type=eq.Protection\n\nThe following REST query is an example of how to retrieve performance policies along with their associated resources: \n \nhttps://{{cluster_ip}}/api/rest/policy?select=name,id,type,volume(id,name),volume_group(id,name)&type=eq.Performance\n", | |
| "summary" : "Collection Query", | |
| "tags" : [ "policy" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/policy_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of policy instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/policy_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "description" : "Create a new protection policy. Protection policies can be assigned to volumes or volume groups. When a protection policy is assigned to a volume or volume group:\n* If the policy is associated with one or more snapshot rules, scheduled snapshots are created based on the schedule specified in each snapshot rule.\n* If the policy is associated with a replication rule, a replication session is created and synchronized based on the schedule specified in the replication rule.\n", | |
| "summary" : "Create", | |
| "tags" : [ "policy" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/policy_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/policy/{id}" : { | |
| "get" : { | |
| "description" : "Query a specific policy.", | |
| "summary" : "Instance Query", | |
| "tags" : [ "policy" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the policy.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "policy" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/policy_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "description" : "Modify a protection policy.\n", | |
| "summary" : "Modify", | |
| "tags" : [ "policy" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the policy to be modified.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "policy" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/policy_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "description" : "Delete a protection policy.\n\nProtection policies that are used by any storage resources can not be deleted.\n", | |
| "summary" : "Delete", | |
| "tags" : [ "policy" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the protection policy to be deleted.", | |
| "type" : "string", | |
| "required" : true | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/snapshot_rule" : { | |
| "get" : { | |
| "description" : "Query all snapshot rules.", | |
| "summary" : "Collection Query", | |
| "tags" : [ "snapshot_rule" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/snapshot_rule_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of snapshot rule instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/snapshot_rule_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "description" : "Create a new snapshot rule.\n", | |
| "summary" : "Create", | |
| "tags" : [ "snapshot_rule" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/snapshot_rule_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/snapshot_rule/{id}" : { | |
| "get" : { | |
| "description" : "Query a specific snapshot rule.", | |
| "summary" : "Instance Query", | |
| "tags" : [ "snapshot_rule" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the snapshot rule.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "snapshot_rule" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/snapshot_rule_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "description" : "Modify a snapshot rule.\n\nIf the rule is associated with a policy that is currently applied to\na storage resource, the modified rule is immediately applied\nto that associated storage resource.\n", | |
| "summary" : "Modify", | |
| "tags" : [ "snapshot_rule" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the snapshot rule.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "snapshot_rule" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/snapshot_rule_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "description" : "Delete a snapshot rule\n", | |
| "summary" : "Delete", | |
| "tags" : [ "snapshot_rule" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the snapshot rule.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "snapshot_rule" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/snapshot_rule_delete" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/replication_rule" : { | |
| "get" : { | |
| "description" : "Query all replication rules.", | |
| "summary" : "Collection Query", | |
| "tags" : [ "replication_rule" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/replication_rule_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of replication rule instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/replication_rule_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "description" : "Create a new replication rule.\n", | |
| "summary" : "Create", | |
| "tags" : [ "replication_rule" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/replication_rule_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/replication_rule/{id}" : { | |
| "get" : { | |
| "description" : "Query a specific replication rule.", | |
| "summary" : "Instance Query", | |
| "tags" : [ "replication_rule" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the replication rule.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "replication_rule" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/replication_rule_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "description" : "Modify a replication rule.\n\nIf the rule is associated with a policy that is currently applied to\na storage resource, the modified rule is immediately applied\nto the associated storage resource.\n\nChanging the remote_system_id is not permitted, if the rule is part of a policy that\nis currently applied to a storage resource. To change the remote system associated with a\nreplication rule, do either of the following:\n\n 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.\n Remove the replication rule from the protection policies that use it, modify the replication rule,\n and then associate it back with the relevant protection policies. \n \n", | |
| "summary" : "Modify", | |
| "tags" : [ "replication_rule" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the replication rule.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "replication_rule" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/replication_rule_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "description" : "Delete a replication rule.\n\nDeleting a rule is not permitted, if the rule is associated with a protection policy that\nis currently applied to a storage resource.\n", | |
| "summary" : "Delete", | |
| "tags" : [ "replication_rule" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the replication rule.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "replication_rule" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/job" : { | |
| "get" : { | |
| "summary" : "Collection query", | |
| "description" : "Query jobs.", | |
| "tags" : [ "job" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "An array of jobs", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/job_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of job instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/job_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/job/{id}" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique id of the job.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "job" | |
| } ], | |
| "get" : { | |
| "summary" : "Instance query", | |
| "description" : "Query a specific job.", | |
| "tags" : [ "job" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "A single job.", | |
| "schema" : { | |
| "$ref" : "#/definitions/job_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/migration_recommendation" : { | |
| "get" : { | |
| "tags" : [ "migration_recommendation" ], | |
| "summary" : "Collection query", | |
| "description" : "Get migration recommendations.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Migration recommendation objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/migration_recommendation_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of migration recommendation instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/migration_recommendation_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "migration_recommendation" ], | |
| "summary" : "Create", | |
| "description" : "Generate a recommendation for redistributing storage utilization between appliances.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/migration_recommendation_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/migration_recommendation/{id}" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique ID of the migration recommendation.", | |
| "x-ref" : "migration_recommendation" | |
| } ], | |
| "get" : { | |
| "tags" : [ "migration_recommendation" ], | |
| "summary" : "Instance query", | |
| "description" : "Get a single migration recommendation.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/migration_recommendation_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "migration_recommendation" ], | |
| "summary" : "Delete", | |
| "description" : "Delete a migration recommendation.", | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/migration_recommendation/{id}/create_migration_sessions" : { | |
| "post" : { | |
| "tags" : [ "migration_recommendation" ], | |
| "summary" : "Create migrations", | |
| "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.\n", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique ID of the migration recommendation.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "migration_recommendation" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/migration_recommendation_create_migration_sessions_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/migration_recommendation/{id}/start_migration_sessions" : { | |
| "post" : { | |
| "tags" : [ "migration_recommendation" ], | |
| "summary" : "Start migrations", | |
| "description" : "Start previously created migration sessions for recommendation. Ensure that any rescans specified in the create_migration_sessions response have been done before using this to start the sessions. Failure to do may result in data unavailability and/or data loss.\n", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique ID of the migration recommendation.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "migration_recommendation" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_unity" : { | |
| "get" : { | |
| "tags" : [ "import_unity" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query Unity storage systems.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_unity_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import unity instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_unity_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_unity/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_unity" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific Unity storage system.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the Unity storage system.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_unity" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_unity_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_unity/{id}/discover" : { | |
| "post" : { | |
| "tags" : [ "import_unity" ], | |
| "summary" : "Discover the importable volumes and consistency groups", | |
| "description" : "Discover the importable volumes and consistency groups in the Unity storage system.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the Unity storage system.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_unity" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_unity_volume" : { | |
| "get" : { | |
| "tags" : [ "import_unity_volume" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query Unity volumes.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_unity_volume_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import unity volume instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_unity_volume_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_unity_volume/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_unity_volume" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific Unity volume.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the Unity volume.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_unity_volume" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_unity_volume_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_unity_volume/{id}/import_snapshot_schedules" : { | |
| "post" : { | |
| "tags" : [ "import_unity_volume" ], | |
| "summary" : "Return snapshot schedules", | |
| "description" : "Return the snapshot schedules associated with the specified Unity volume.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the Unity volume.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_unity_volume" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_unity_volume_import_snapshot_schedules_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_unity_consistency_group" : { | |
| "get" : { | |
| "tags" : [ "import_unity_consistency_group" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query Unity consistency groups.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_unity_consistency_group_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import unity consistency group instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_unity_consistency_group_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_unity_consistency_group/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_unity_consistency_group" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific Unity consistency group.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the Unity consistency group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_unity_consistency_group" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_unity_consistency_group_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_unity_consistency_group/{id}/import_snapshot_schedules" : { | |
| "post" : { | |
| "tags" : [ "import_unity_consistency_group" ], | |
| "summary" : "Return snapshot schedules", | |
| "description" : "Return the snapshot schedules associated with the specified Unity consistency group.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the Unity consistency group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_unity_consistency_group" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_unity_consistency_group_import_snapshot_schedules_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_psgroup" : { | |
| "get" : { | |
| "tags" : [ "import_psgroup" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query PS Group storage arrays.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_psgroup_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import psgroup instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_psgroup_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_psgroup/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_psgroup" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific PS Group storage array.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the PS Group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_psgroup" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_psgroup_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_psgroup/{id}/discover" : { | |
| "post" : { | |
| "tags" : [ "import_psgroup" ], | |
| "description" : "Discover the importable volumes and snapshot schedules in the PS Group.", | |
| "summary" : "Discover importable storage resources", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the PS Group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_psgroup" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_psgroup_volume" : { | |
| "get" : { | |
| "tags" : [ "import_psgroup_volume" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query PS Group volumes.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_psgroup_volume_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import psgroup volume instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_psgroup_volume_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_psgroup_volume/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_psgroup_volume" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific PS Group volume.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the PS Group volume.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_psgroup_volume" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_psgroup_volume_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_psgroup_volume/{id}/import_snapshot_schedules" : { | |
| "post" : { | |
| "tags" : [ "import_psgroup_volume" ], | |
| "summary" : "Return snapshot schedules", | |
| "description" : "Return the snapshot schedules for a PS Group volume.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the PS Group volume.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_psgroup_volume" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_psgroup_volume_import_snapshot_schedules_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_storage_center" : { | |
| "get" : { | |
| "tags" : [ "import_storage_center" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query SC arrays.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_storage_center_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import storage center instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_storage_center_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_storage_center/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_storage_center" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific SC array.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the SC array.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_storage_center" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_storage_center_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_storage_center/{id}/discover" : { | |
| "post" : { | |
| "tags" : [ "import_storage_center" ], | |
| "description" : "Discover the importable volumes and snapshot profiles in the SC array.", | |
| "summary" : "Discover importable resources", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the SC array.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_storage_center" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_storage_center_volume" : { | |
| "get" : { | |
| "tags" : [ "import_storage_center_volume" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query SC volumes.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_storage_center_volume_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import storage center volume instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_storage_center_volume_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_storage_center_volume/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_storage_center_volume" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific SC volume.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the SC volume.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_storage_center_volume" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_storage_center_volume_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_storage_center_consistency_group" : { | |
| "get" : { | |
| "tags" : [ "import_storage_center_consistency_group" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query SC consistency groups.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_storage_center_consistency_group_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import storage center consistency group instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_storage_center_consistency_group_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_storage_center_consistency_group/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_storage_center_consistency_group" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific SC consistency group.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the SC consistency group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_storage_center_consistency_group" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_storage_center_consistency_group_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_storage_center_volume/{id}/import_snapshot_profiles" : { | |
| "post" : { | |
| "tags" : [ "import_storage_center_volume" ], | |
| "summary" : "Return snapshot profiles", | |
| "description" : "Return the snapshot profiles of an SC volume.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the SC volume.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_storage_center_volume" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_storage_center_volume_import_snapshot_profiles_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed.", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_storage_center_consistency_group/{id}/import_snapshot_profiles" : { | |
| "post" : { | |
| "tags" : [ "import_storage_center_consistency_group" ], | |
| "summary" : "Return snapshot profiles", | |
| "description" : "Return the snapshot profiles of an SC consistency group.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the SC consistency group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_storage_center_consistency_group" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_storage_center_consistency_group_import_snapshot_profiles_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed.", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_vnx_array" : { | |
| "get" : { | |
| "tags" : [ "import_vnx_array" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query VNX storage systems.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_vnx_array_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import vnx array instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_vnx_array_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_vnx_array/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_vnx_array" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific VNX storage system.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of a VNX storage system.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_vnx_array" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_vnx_array_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_vnx_array/{id}/discover" : { | |
| "post" : { | |
| "tags" : [ "import_vnx_array" ], | |
| "description" : "Discover the importable volumes and consistency groups in a VNX storage system.", | |
| "summary" : "Discover Importable Resources", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the VNX storage system.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_vnx_array" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_vnx_volume" : { | |
| "get" : { | |
| "tags" : [ "import_vnx_volume" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query VNX volumes.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_vnx_volume_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import vnx volume instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_vnx_volume_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_vnx_volume/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_vnx_volume" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific VNX volume.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the VNX volume.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_vnx_volume" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_vnx_volume_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_vnx_consistency_group" : { | |
| "get" : { | |
| "tags" : [ "import_vnx_consistency_group" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query VNX consistency groups.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_vnx_consistency_group_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import vnx consistency group instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_vnx_consistency_group_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_vnx_consistency_group/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_vnx_consistency_group" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific VNX consistency group.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of a VNX consistency group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_vnx_consistency_group" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_vnx_consistency_group_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_host_system" : { | |
| "get" : { | |
| "tags" : [ "import_host_system" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query import host systems that are attached to volumes.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_host_system_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import host system instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_host_system_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "import_host_system" ], | |
| "summary" : "Create", | |
| "description" : "Add an import host system so that it can be mapped to a volume. Before mapping an import host system, ensure that a host agent is installed. Host agents can be installed on Linux, Windows, and ESXi host systems only. While adding import_host_system if Host is not present a new Host shall be created. If Host is already present, the same Host will be updated with the import_host_system details.", | |
| "parameters" : [ { | |
| "name" : "request", | |
| "in" : "body", | |
| "description" : "Request parameters.", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/import_host_system_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_host_system/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_host_system" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific import host system instance.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the import host system to query.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_host_system" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_host_system_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "import_host_system" ], | |
| "summary" : "Delete", | |
| "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.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the import host system", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_host_system" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_host_system/{id}/refresh" : { | |
| "post" : { | |
| "tags" : [ "import_host_system" ], | |
| "summary" : "Refresh", | |
| "description" : "Refresh the details of a specific import host system. Use this operation when there is a change to the import host or import host volumes.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the import host system for which to refresh details.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_host_system" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_host_volume" : { | |
| "get" : { | |
| "tags" : [ "import_host_volume" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query import host volumes.", | |
| "x-ref" : "import_host_volume", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_host_volume_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import host volume instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_host_volume_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_host_volume/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_host_volume" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific import host volume instance.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the import host volume to query.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_host_volume" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_host_volume_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_host_initiator" : { | |
| "get" : { | |
| "tags" : [ "import_host_initiator" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query import host initiators.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_host_initiator_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import host initiator instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_host_initiator_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_host_initiator/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_host_initiator" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific import host initiator instance.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the import host initiator to query.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_host_initiator" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_host_initiator_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/virtual_volume" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Get virtual volumes.", | |
| "tags" : [ "virtual_volume" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/virtual_volume_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of virtual volume instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/virtual_volume_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/virtual_volume/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Get a specific virtual volume.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "type" : "string", | |
| "description" : "Id of the virtual volume.", | |
| "required" : true, | |
| "x-ref" : "virtual_volume" | |
| } ], | |
| "tags" : [ "virtual_volume" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/virtual_volume_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/vvol_error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "summary" : "Delete", | |
| "description" : "Delete a virtual volume.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "type" : "string", | |
| "description" : "Unique identifier of the virtual volume to delete.", | |
| "required" : true, | |
| "x-ref" : "virtual_volume" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : false, | |
| "description" : "Options to delete a virtual volume.", | |
| "schema" : { | |
| "$ref" : "#/definitions/virtual_volume_delete" | |
| } | |
| } ], | |
| "tags" : [ "virtual_volume" ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/virtual_machine" : { | |
| "get" : { | |
| "tags" : [ "virtual_machine" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query virtual machines that use storage from the cluster.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/virtual_machine_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of virtual machine instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/virtual_machine_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/virtual_machine/{id}" : { | |
| "get" : { | |
| "tags" : [ "virtual_machine" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific virtual machine instance.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the virtual machine to query.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "virtual_machine" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/virtual_machine_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "virtual_machine" ], | |
| "summary" : "Modify", | |
| "description" : "Modify a virtual machine. This operation cannot be used on virtual machine snapshots or templates.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the virtual machine to modify.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "virtual_machine" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/virtual_machine_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "virtual_machine" ], | |
| "summary" : "Delete", | |
| "description" : "Delete a virtual machine snapshot. This operation cannot be used on a base virtual machine or virtual machine template.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the virtual machine snapshot to delete.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "virtual_machine" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/virtual_machine/{id}/snapshot" : { | |
| "post" : { | |
| "tags" : [ "virtual_machine" ], | |
| "summary" : "Snapshot", | |
| "description" : "Create a snapshot of a virtual machine. This operation cannot be used on a virtual machine snapshot or template.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the virtual machine to create a snapshot of.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "virtual_machine" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/virtual_machine_snapshot" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/virtual_machine_snapshot_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_session" : { | |
| "get" : { | |
| "tags" : [ "import_session" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query import sessions.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_session_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of import session instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_session_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "import_session" ], | |
| "summary" : "Create", | |
| "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.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/import_session_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_session/{id}" : { | |
| "get" : { | |
| "tags" : [ "import_session" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific session.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the import session", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_session" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/import_session_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "import_session" ], | |
| "summary" : "Delete", | |
| "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.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the import session", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_session" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "import_session" ], | |
| "summary" : "Modify", | |
| "description" : "Modify the scheduled date and time of the specified import session.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the import session.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_session" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/import_session_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_session/{id}/cutover" : { | |
| "post" : { | |
| "tags" : [ "import_session" ], | |
| "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. Until the cutover is complete, PowerStore forwards IO to the source volume to keep it in sync with all host IOs. You can cancel the import during this state if you want to continue using the source volume.", | |
| "summary" : "Cutover", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of an import session", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_session" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_session/{id}/cancel" : { | |
| "post" : { | |
| "tags" : [ "import_session" ], | |
| "summary" : "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. In most cases, the Cancel operation gracefully rolls back the import based on the source and host error responses. Use the force option to stop the import job irrespective of whether the storage system or hosts have issues. When the force option is true, the import process tries to reach out to the source and host to gracefully terminate the import. If either are not reachable or if the request fails, the import is terminated without rolling back.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the import session", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_session" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : false, | |
| "schema" : { | |
| "$ref" : "#/definitions/import_session_cancel" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_session/{id}/pause" : { | |
| "post" : { | |
| "tags" : [ "import_session" ], | |
| "description" : "Pauses an ongoing import session. When this occurs, the background data copy stops, but IO to the source still occurs. Pause is only supported when the import job is in a in Copy_In_Progress state. You can resume or cancel the paused import.", | |
| "summary" : "Pause", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the import session", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_session" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_session/{id}/resume" : { | |
| "post" : { | |
| "tags" : [ "import_session" ], | |
| "description" : "Resumes the paused import session. The background data copy continues from where it was stopped. Resume is only applicable when the import in a Paused state.", | |
| "summary" : "Resume", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the import session", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_session" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/import_session/{id}/cleanup" : { | |
| "post" : { | |
| "tags" : [ "import_session" ], | |
| "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.", | |
| "summary" : "Cleanup", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the import session.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "import_session" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/local_user" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query all local user account instances. \nThis resource type collection query does not support filtering, sorting or pagination", | |
| "x-simple_get" : true, | |
| "tags" : [ "local_user" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/local_user_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of local user instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/local_user_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "summary" : "Create", | |
| "description" : "Create a new local user account. Any existing local user with either an administrator or a security administrator role can create a new local user account. By default, a new local_user account is NOT locked.", | |
| "tags" : [ "local_user" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/local_user_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/local_user/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific local user account instance using an unique identifier.", | |
| "x-simple_get" : true, | |
| "tags" : [ "local_user" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the local user account.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "local_user" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/local_user_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "summary" : "Delete", | |
| "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.", | |
| "tags" : [ "local_user" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the local user account to be deleted.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "local_user" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "summary" : "Modify", | |
| "description" : "Modify a property of a local user account using the unique identifier. You cannot modify the default \"admin\" user account.", | |
| "tags" : [ "local_user" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the local user account to be modified.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "local_user" | |
| }, { | |
| "in" : "body", | |
| "name" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/local_user_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/login_session" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Obtain the login session for the current user. \nThis resource type collection query does not support filtering, sorting or pagination", | |
| "x-simple_get" : true, | |
| "tags" : [ "login_session" ], | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/login_session_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of login session instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/login_session_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/logout" : { | |
| "post" : { | |
| "summary" : "Logout", | |
| "description" : "Log out the current user.", | |
| "tags" : [ "logout" ], | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/role" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query roles. \nThis resource type collection query does not support filtering, sorting or pagination", | |
| "x-simple_get" : true, | |
| "tags" : [ "role" ], | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/role_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of role instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/role_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/role/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific role.", | |
| "x-simple_get" : true, | |
| "tags" : [ "role" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the role.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "role" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/role_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/security_config" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query system security configurations. \nThis resource type collection query does not support filtering, sorting or pagination", | |
| "x-simple_get" : true, | |
| "tags" : [ "security_config" ], | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/security_config_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of security config instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/security_config_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/security_config/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific system security configuration.", | |
| "x-simple_get" : true, | |
| "tags" : [ "security_config" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the system security configuration.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "security_config" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/security_config_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/service_user" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query the service user account instance. \nThis resource type collection query does not support filtering, sorting or pagination", | |
| "x-simple_get" : true, | |
| "tags" : [ "service_user" ], | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/service_user_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of service user instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/service_user_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/service_user/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Query the service user account using the unique identifier.", | |
| "x-simple_get" : true, | |
| "tags" : [ "service_user" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the service user.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "service_user" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/service_user_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "summary" : "Modify", | |
| "description" : "Modify the properties of the service user account.", | |
| "tags" : [ "service_user" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the service user account.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "service_user" | |
| }, { | |
| "in" : "body", | |
| "name" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/service_user_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/x509_certificate" : { | |
| "get" : { | |
| "description" : "Query to list X509 Certificates instances. \nThis resource type collection query does not support filtering, sorting or pagination", | |
| "x-simple_get" : true, | |
| "summary" : "Collection Query", | |
| "tags" : [ "x509_certificate" ], | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/x509_certificate_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of x 509 certificate instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/x509_certificate_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/x509_certificate/{id}" : { | |
| "get" : { | |
| "description" : "Query a specific X509 Certificate instance.", | |
| "x-simple_get" : true, | |
| "summary" : "Instance Query", | |
| "tags" : [ "x509_certificate" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the X509 Certificate.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "x509_certificate" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/x509_certificate_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/x509_certificate/exchange" : { | |
| "post" : { | |
| "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.", | |
| "summary" : "Exchange Certificates", | |
| "tags" : [ "x509_certificate" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "description" : "Request body.", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/x509_certificate_exchange" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/x509_certificate/decommission" : { | |
| "post" : { | |
| "description" : "Decommission x509 certificates for one service type (currently only Replication_HTTP is supported) of one scope (for example remote system)", | |
| "summary" : "Decommission Certificates", | |
| "tags" : [ "x509_certificate" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "description" : "Request body.", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/x509_certificate_decommission" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/license" : { | |
| "get" : { | |
| "tags" : [ "license" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query license information for the cluster. There is always one license instance.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/license_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of license instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/license_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/license/{id}" : { | |
| "get" : { | |
| "tags" : [ "license" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query the specific license information for the cluster.", | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique identifier of the license information instance.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "license" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/license_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/license/upload" : { | |
| "post" : { | |
| "tags" : [ "license" ], | |
| "summary" : "License File Upload", | |
| "description" : "Upload a software license to install the license on the cluster.", | |
| "consumes" : [ "multipart/form-data" ], | |
| "parameters" : [ { | |
| "in" : "formData", | |
| "name" : "license_file", | |
| "type" : "file", | |
| "description" : "The file to upload containing the software license to install the license on the cluster." | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/license/retrieve" : { | |
| "post" : { | |
| "tags" : [ "license" ], | |
| "summary" : "Retrieve License", | |
| "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.", | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume_group" : { | |
| "get" : { | |
| "description" : "Query all volume groups, including snapshot sets and clones of volume groups.\n", | |
| "summary" : "Collection Query", | |
| "tags" : [ "volume_group" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/volume_group_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of volume group instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/volume_group_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "description" : "Create a new volume group. The resulting volume group will have a type of Primary.\n", | |
| "summary" : "Create", | |
| "tags" : [ "volume_group" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume_group/{id}" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the volume group.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "volume_group" | |
| } ], | |
| "get" : { | |
| "description" : "Query a specific volume group, snapshot set, or clone.", | |
| "summary" : "Instance Query", | |
| "tags" : [ "volume_group" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "description" : "Modify a volume group, snapshot set, or clone.", | |
| "summary" : "Modify", | |
| "tags" : [ "volume_group" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "description" : "Delete a volume group, snapshot set, or clone.\nBefore you try deleting a volume group, snapshot set, or clone, ensure that you first detach it from all hosts. Note the following:\n* When a volume group or clone is deleted, all related snapshot sets will also be deleted.\n* When a snapshot set is deleted, all of its constituent snapshots will also be deleted.\n", | |
| "summary" : "Delete", | |
| "tags" : [ "volume_group" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_delete" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume_group/{id}/add_members" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the volume group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "volume_group" | |
| } ], | |
| "post" : { | |
| "description" : "Add member volumes to an existing primary or clone volume group.\nThis cannot be used to add members to a snapshot set. Members cannot be added to a volume group that is acting as the destination in a replication session.\n", | |
| "summary" : "Add Members", | |
| "tags" : [ "volume_group" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_add_members" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume_group/{id}/remove_members" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the volume group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "volume_group" | |
| } ], | |
| "post" : { | |
| "description" : "Remove members from an existing primary or clone volume group.\nThis 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.\n", | |
| "summary" : "Remove Members", | |
| "tags" : [ "volume_group" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_remove_members" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume_group/{id}/snapshot" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the volume group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "volume_group" | |
| } ], | |
| "post" : { | |
| "description" : "Create a new snapshot set for a volume group.\nWhen a snapshot of a volume group is created, the resultant snapshot volume group is referred to as a \"snapshot set\" and it represents a point-in-time copy of the members in the volume group. The snapshot set will be created on the same appliance as the source volume group.\nA 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.\nWhen the source of a snapshot operation is a primary or clone volume group, \n* __source_id__ of the snapshot set will be set to the identifier of the source volume group. \n* __source_time__ of the snapshot set will be set to the time at which the snapshot set will be created.\n\nThe __is_write_order_consistent__ property of the source volume group determines whether the snapshot set will be write-order consistent.\n", | |
| "summary" : "Snapshot", | |
| "tags" : [ "volume_group" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_snapshot" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_snapshot_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume_group/{id}/clone" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the volume group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "volume_group" | |
| } ], | |
| "post" : { | |
| "description" : "Clone a volume group. The clone volume group will be created on the same appliance as the source volume group.\nA clone of a volume group will result in a new volume group of __Clone__ type. The clone will belong to the same family as the source volume group.\nWhen the source of a clone operation is a either primary or clone volume group, \n* __source_id__ will be set to the identifier of the source volume group. \n* __source_time__ will be set to the time at which the clone will be created.\n\nWhen the source of a clone operation is a snapshot set, \n* __source_id__ will be set to the source_id of the source snapshot set. \n* __source_time__ will be set to the source_time of the source snapshot set.\n\nThe 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.\n", | |
| "summary" : "Clone", | |
| "tags" : [ "volume_group" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_clone" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_clone_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume_group/{id}/restore" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the volume group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "volume_group" | |
| } ], | |
| "post" : { | |
| "description" : "Restore a volume group from a snapshot set. A primary or a clone volume group can only be restored from one of its immediate snapshot sets.\nA backup snapshot set of the target volume group will be created before restore is attempted. This behavior can be overridden by setting the __create_backup_snap__ property to false. \nThe profile for the backup snapshot set will be auto-generated unless a custom profile is specified. The auto-generated profile only initializes the name to an auto-generated, unique value. Other optional parameters are not specified.\nRestore operation is only supported if there are no membership changes between the target volume group and source snapshot set.\nYou can restore a volume group even when the sizes of the volumes in the target 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.\nWhen a volume group is restored, \n* __source_time__ is set to the __source_time__ of the snapshot set it is being restored from.\n\nA volume group that is acting as the destination in a replication session cannot be restored.\n", | |
| "summary" : "Restore", | |
| "tags" : [ "volume_group" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_restore" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_restore_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume_group/{id}/refresh" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the volume group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "volume_group" | |
| } ], | |
| "post" : { | |
| "description" : "\nRefresh the contents of a volume group (the target volume group) from another volume group in the same family.\nA backup snapshot set of the target volume group will be created before refresh is attempted. This behavior can be overridden by setting the __create_backup_snap__ property to false. The profile for the backup snapshot set will be auto-generated, unless a custom profile is specified. The auto-generated profile only initializes the name to an auto-generated, unique value. Other optional parameters are not specified.\nThe table below outlines supported modes of operation and resulting updates to __source_id__ and __source_time__ attributes of __protection_data__.\n|Target volume group|Source volume group|New source_id|New source_time|\n|-|-|-|-|\n|Primary (P1) |Clone (C1)|id of clone (C1)|Current time|\n|Primary (P1) |snapshot set (C1S1) of clone (C1)|id of source snapshot set (C1S1)|source_time of source snapshot set (C1S1)|\n|Clone (C1) |Primary (P1)|id of primary (P1)|Current time|\n|Clone (C1) |snapshot set (S1) of primary (P1)|id of source snapshot set (S1)|source_time of source snapshot set (S1)|\n|Clone (C1) |Clone (C2)|id of source clone(C2)|Current time|\n|Clone (C1) |snapshot set (C2S1) of clone (C2)|id of source snapshot set (C2S1)|source_time of source snapshot set (C2S1)|\nRefresh operation is only supported if there are no membership changes between the source and target volume groups of the refresh operation. You can refresh a volume group even when the sizes of the volumes in the target volume group have changed. This represents a case where the source volumes have been modified over time and you want to refresh the target to the new state of the source volume group. A volume group that is acting as the destination in a replication session cannot be refreshed.\n", | |
| "summary" : "Refresh", | |
| "tags" : [ "volume_group" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_refresh" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_group_refresh_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/host" : { | |
| "get" : { | |
| "tags" : [ "host" ], | |
| "summary" : "Collection Query", | |
| "description" : "List host information.", | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of host instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "host" ], | |
| "summary" : "Create", | |
| "description" : "Add a host.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/host_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Input", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/host/{id}" : { | |
| "get" : { | |
| "tags" : [ "host" ], | |
| "summary" : "Instance Query", | |
| "description" : "Get details about a specific host by id.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique id of the host.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "host" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/host_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "host" ], | |
| "summary" : "Modify", | |
| "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.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique id of the host.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "host" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/host_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Input", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "host" ], | |
| "summary" : "Delete", | |
| "description" : "Delete a host. Delete fails if host is attached to a volume or consistency group.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique id of the host.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "host" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : false, | |
| "schema" : { | |
| "$ref" : "#/definitions/host_delete" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Input", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/host/{id}/attach" : { | |
| "post" : { | |
| "tags" : [ "host" ], | |
| "summary" : "Attach", | |
| "description" : "Attach host to volume.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique id of the host.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "host" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/host_attach" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Input", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/host/{id}/detach" : { | |
| "post" : { | |
| "tags" : [ "host" ], | |
| "summary" : "Detach", | |
| "description" : "Detach host from volume.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique id of the host.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "host" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/host_detach" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Input", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/host_group" : { | |
| "get" : { | |
| "tags" : [ "host_group" ], | |
| "summary" : "Collection Query", | |
| "description" : "List host groups.", | |
| "produces" : [ "application/json" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_group_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of host group instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_group_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "host_group" ], | |
| "summary" : "Create", | |
| "description" : "Create a host group.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/host_group_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/host_group/{id}" : { | |
| "get" : { | |
| "tags" : [ "host_group" ], | |
| "description" : "Get details about a specific host group.", | |
| "summary" : "Instance Query", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique id of the host group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "host_group" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/host_group_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "host_group" ], | |
| "summary" : "Modify", | |
| "description" : "Operations that can be performed are modify name, remove host(s) from host group, add host(s) to host group. Modify request will only support either a add_host(s) or remove_host(s) at a time along with modifying host name", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique id of the host group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "host_group" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/host_group_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "host_group" ], | |
| "summary" : "Delete", | |
| "description" : "Delete a host group. Delete fails if host group is attached to a volume.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique id of the host group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "host_group" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/host_group/{id}/attach" : { | |
| "post" : { | |
| "tags" : [ "host_group" ], | |
| "summary" : "Attach", | |
| "description" : "Attach host group to volume.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique id of the host group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "host_group" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/host_group_attach" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Input", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/host_group/{id}/detach" : { | |
| "post" : { | |
| "tags" : [ "host_group" ], | |
| "summary" : "Detach", | |
| "description" : "Detach host group from volume.", | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "Unique id of the host group.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "host_group" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/host_group_detach" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Input", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/hardware" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "List hardware components.", | |
| "produces" : [ "application/json" ], | |
| "tags" : [ "hardware" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/hardware_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of hardware instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/hardware_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/hardware/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Get a specific hardware component instance.", | |
| "produces" : [ "application/json" ], | |
| "tags" : [ "hardware" ], | |
| "parameters" : [ { | |
| "type" : "string", | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "description" : "Unique id of hardware component to get.", | |
| "x-ref" : "hardware" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/hardware_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "summary" : "Modify", | |
| "description" : "Modify a hardware instance.", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "tags" : [ "hardware" ], | |
| "parameters" : [ { | |
| "type" : "string", | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "description" : "The hardware component to modify.", | |
| "x-ref" : "hardware" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/hardware_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/hardware/{id}/drive_repurpose" : { | |
| "post" : { | |
| "summary" : "Repurpose a drive", | |
| "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.", | |
| "produces" : [ "application/json" ], | |
| "tags" : [ "hardware" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "type" : "string", | |
| "required" : true, | |
| "description" : "Identifier of the drive to repurpose.", | |
| "x-ref" : "hardware" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "description" : "Fields required to repurpose the specified drive.", | |
| "schema" : { | |
| "$ref" : "#/definitions/hardware_drive_repurpose" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume" : { | |
| "get" : { | |
| "description" : "Query volumes that are provisioned on the appliance.", | |
| "summary" : "Collection Query", | |
| "tags" : [ "volume" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/volume_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of volume instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/volume_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "description" : "Create a volume on the appliance.", | |
| "summary" : "Create", | |
| "tags" : [ "volume" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume/{id}" : { | |
| "get" : { | |
| "description" : "Query a specific volume instance.", | |
| "summary" : "Instance Query", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "description" : "Unique identifier of the volume to query.", | |
| "in" : "path", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "volume" | |
| } ], | |
| "tags" : [ "volume" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "description" : "Modify the parameters of a volume.", | |
| "summary" : "Modify", | |
| "tags" : [ "volume" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "description" : "Unique identifier of the volume to modify.", | |
| "in" : "path", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "volume" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "description" : "Delete a volume. \n\n* A volume which is attached to a host or host group or is a member of a volume group cannot be deleted.\n* A volume which has protection policies attached to it cannot be deleted.\n* A volume which has snapshots that are part of a snapset cannot be deleted.\n* Clones of a deleted production volume or a clone are not deleted.\n* Snapshots of the volume are deleted along with the volume being deleted.", | |
| "summary" : "Delete", | |
| "tags" : [ "volume" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "description" : "Unique identifier of the volume to delete.", | |
| "in" : "path", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "volume" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume/{id}/snapshot" : { | |
| "post" : { | |
| "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.", | |
| "summary" : "Snapshot", | |
| "tags" : [ "volume" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "description" : "Unique identifier of the volume or clone to create a snapshot of.", | |
| "in" : "path", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "volume" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : false, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_snapshot" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_snapshot_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume/{id}/clone" : { | |
| "post" : { | |
| "description" : "Create a clone of a volume or snapshot.", | |
| "summary" : "Clone", | |
| "tags" : [ "volume" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "description" : "Unique identifier of the volume or snapshot to create a clone of.", | |
| "in" : "path", | |
| "type" : "string", | |
| "x-ref" : "volume", | |
| "required" : true | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : false, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_clone" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_clone_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume/{id}/refresh" : { | |
| "post" : { | |
| "description" : "Refresh the contents of the target volume from another volume in the same family. By default, a backup snapshot of the target volume is not created before the refresh is attempted. To create a snapshot before refreshing, set __create_backup_snap__ to true. If a snapshot is taken, the response includes the resulting snapshot id; otherwise it is empty. If a custom profile is not specified, the profile for the backup snapshot is automatically generated. The automatically generated profile only provides the name as an automatically generated, unique value. Other optional parameters are not specified. When a volume is refreshed, the source_time is the source_time of the volume from which it is refreshed.", | |
| "summary" : "Refresh", | |
| "tags" : [ "volume" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "description" : "Unique identifier of volume for which to refresh contents.", | |
| "in" : "path", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "volume" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_refresh" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_refresh_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume/{id}/restore" : { | |
| "post" : { | |
| "description" : "Restore a volume from a snapshot. A primary or clone volume can only be restored from one of its immediate snapshots. By default, a backup snapshot of the target snapshot is created before the restore is attempted. To skip creating a snapshot before restoring, set create_backup_snap to false. If a snapshot is taken, the response includes the resulting snapshot id; otherwise it is empty. If a custom profile is not specified, the profile for the backup snapshot is automatically generated. The automatically generated profile only provides the name as an automatically generated, unique value. Other optional parameters are not specified. When a volume is restored, the source_time is the source_time of the snapshot from which it is restored.", | |
| "summary" : "Restore", | |
| "tags" : [ "volume" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "description" : "Unique identifier of the volume to restore.", | |
| "in" : "path", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "volume" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_restore" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_restore_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume/{id}/attach" : { | |
| "post" : { | |
| "description" : "Attach a volume to a host or host group.", | |
| "summary" : "Attach", | |
| "tags" : [ "volume" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "description" : "Unique identifier of volume to attach.", | |
| "in" : "path", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "volume" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_attach" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/volume/{id}/detach" : { | |
| "post" : { | |
| "description" : "Detach a volume from a host or host group.", | |
| "summary" : "Detach", | |
| "tags" : [ "volume" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "description" : "Unique identifier of volume to detach.", | |
| "in" : "path", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "volume" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/volume_detach" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/host_volume_mapping" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query associations between a volume and the host or host group it is attached to.", | |
| "tags" : [ "host_volume_mapping" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_volume_mapping_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of host volume mapping instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_volume_mapping_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/host_volume_mapping/{id}" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the host volume mapping.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "host_volume_mapping" | |
| } ], | |
| "get" : { | |
| "description" : "Query a specific host volume mapping.", | |
| "summary" : "Instance Query", | |
| "tags" : [ "host_volume_mapping" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/host_volume_mapping_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/discovered_initiator" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Returns connected initiators that are not associated with a host. \nThis resource type collection query does not support filtering, sorting or pagination", | |
| "x-simple_get" : true, | |
| "produces" : [ "application/json" ], | |
| "tags" : [ "discovered_initiator" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/discovered_initiator_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of discovered initiator instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/discovered_initiator_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/remote_system" : { | |
| "get" : { | |
| "description" : "Query remote systems.\n", | |
| "summary" : "Collection Query", | |
| "tags" : [ "remote_system" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/remote_system_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of remote system instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/remote_system_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "description" : "Create a new remote system relationship. The type of remote system being connected requires different parameter sets. \nFor PowerStore remote system relationships, include the following parameters:\n* Management address - Either an IPv4 or IPv6 address. FQDN is not supported.\n* Type of remote system \n* Data network latency type\n\n\n\n\nFor PowerStore remote system relationships, the relationship is created in both directions. Remote protection policies can be configured using the PowerStore remote system instance on either of the systems. This enables remote replication for storage resources in either direction. The data connections take into account whether Challenge Handshake Authentication Protocol (CHAP) is enabled on local and remote PowerStore systems.\n\n\n\n\nFor non-PowerStore remote system relationships, include the following parameters:\n* Management address - Either an IPv4 or IPv6 address. FQDN is not supported.\n* Type of remote system\n* Name\n* Description\n* Remote administrator credentials\n* iSCSI address - IPv4 address\n* CHAP mode for discovery or session \n* CHAP secrets details\n\n\n\n\nAfter the remote system relationship is created, the local system can communicate with the remote system, and open data connections for data transfer.\n", | |
| "summary" : "Create", | |
| "tags" : [ "remote_system" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "description" : "Parameters to create a remote system.\n", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/remote_system_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/remote_system/{id}" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the remote system.\n", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "remote_system" | |
| } ], | |
| "get" : { | |
| "description" : "Query a remote system instance.\n", | |
| "summary" : "Instance Query", | |
| "tags" : [ "remote_system" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/remote_system_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "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.\n\n\n\n\nFor PowerStore remote systems, the relationship is deleted in both directions if the remote system is up and connectable. You cannot delete a PowerStore remote system if there is no management connectivity between the local and remore systems. Only the local end of the relationship is deleted. Manually log in to the remote PowerStore system and remove the relationship.\n", | |
| "summary" : "Delete", | |
| "tags" : [ "remote_system" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "description" : "Parameters to delete a remote system.\n", | |
| "schema" : { | |
| "$ref" : "#/definitions/remote_system_delete" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "description" : "Modify a remote system instance. The list of valid parameters depends on the type of remote system.\n\n\n\n\nFor PowerStore remote system relationships:\n\n* Description\n* Management address - An IPv4 or IPv6 address. FQDN is not supported.\n\n\n\n\nFor non-PowerStore remote system relationships:\n\n* Name\n* Description\n* Management address - An IPv4 address. FQDN is not supported.\n* Remote administrator credentials\n* iSCSI address - An IPv4 address.\n\n\n\n\nAfter modifying the remote session instance, the system reestablishes the data connections as needed.\n", | |
| "summary" : "Modify", | |
| "tags" : [ "remote_system" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "description" : "Parameters to modify the remote system.\n", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/remote_system_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/remote_system/{id}/verify" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the remote system.\n", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "remote_system" | |
| } ], | |
| "post" : { | |
| "description" : "Verify and update the remote system instance. \n\n\n\n\nDetects changes in the local and remote systems and reestablishes data connections, also taking the Challenge Handshake Authentication Protocol (CHAP) settings into account.\n", | |
| "summary" : "Verify", | |
| "tags" : [ "remote_system" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "description" : "Parameters to verify a remote system.\n", | |
| "schema" : { | |
| "$ref" : "#/definitions/remote_system_verify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/replication_session" : { | |
| "get" : { | |
| "description" : "Query replication sessions.\n", | |
| "summary" : "Collection Query", | |
| "tags" : [ "replication_session" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/replication_session_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of replication session instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/replication_session_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/replication_session/{id}" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the replication session.\n", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "replication_session" | |
| } ], | |
| "get" : { | |
| "description" : "Query a replication session instance.\n", | |
| "summary" : "Instance Query", | |
| "tags" : [ "replication_session" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/replication_session_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/replication_session/{id}/sync" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the replication session.\n", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "replication_session" | |
| } ], | |
| "post" : { | |
| "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. \n\n\n \n\n\nAlso synchronizes any size changes, membership changes, or both, on the source resource. At the end of the synchronization cycle, the destination resource reflects the state as it was when synchronization began. Any size changes, membership changes, or both, to source resource done during the synchronization cycle are replicated in next synchronization cycle.\n\n\n\n\nSynchronization is allowed when the replication session is in the following states:\n* OK\n* System_Paused\n\n\n\n\nDuring synchronization, you can take the following actions:\n* Planned failover from the source system\n* Failover from the destination system\n* Pause replication sessions from the source or destination system\n* Delete a replication session by removing a protection policy\n\n\n\n\nSynchronization failure places the replication session in a System_Paused state. When the system recovers, the replication session continues from the same point as when the system paused, using the restart address.\n", | |
| "summary" : "Synchronize", | |
| "tags" : [ "replication_session" ], | |
| "parameters" : [ ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/replication_session/{id}/pause" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the replication session.\n", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "replication_session" | |
| } ], | |
| "post" : { | |
| "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. \n\n\n\n\nThe session can be paused when it is in the following states:\n* OK - Remembers the replication session state before pausing, and resumes to OK state\n* Synchronizing - Remembers the restart address before pausing, and resumes from the restart address\n* System_Paused - Remembers the restart address before pausing, and resumes from the restart address as recorded when the system entered the System_Paused state\n\n\n\n\nIn case of loss of network connectivity between two sites, the replication session is paused only on the local system where it is issued. Pause the replication session again to pause both sites. The following operations are not allowed while only the replication session on the local system is paused:\n* Resume\n* Sync\n* Planned Failover\n\n\n\n\nThe following operations are allowed while only the replication session on the local system is paused:\n* Pause - Use to place both sites into the **Paused** state\n* Failover - Use to get production access from the disaster recovery site\n* Delete the replication session by removing the protection policy on the storage resource\n\n\n\n\nThe following system operations may also pause, and subsequently resume, a replication session:\n* Non-disruptive upgrade\n* Intra-cluster migration \n\n\n\n\nLeaving replication session in a paused state results in change accumulations on the source system, and consume more storage on the source system. Resuming a replication session that has been paused for a long time can result in long synchronization times. \n", | |
| "summary" : "Pause", | |
| "tags" : [ "replication_session" ], | |
| "parameters" : [ ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/replication_session/{id}/resume" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the replication session.\n", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "replication_session" | |
| } ], | |
| "post" : { | |
| "description" : "Resume a replication session instance that is paused. Resuming the replication session schedules a synchronization cycle if the session was in the following states when the session was paused:\n* Synchronizing\n* System_Paused \n\n\n\n\nWhen only the replication session on the local system is paused, resuming the session pauses both sites.\n\n\n\n\nYou cannot resume replication sessions paused by the system. The following system operations may also pause, and subsequently resume, a replication session. \n* Paused_for_NDU\n* Paused_for_Migration \n", | |
| "summary" : "Resume", | |
| "tags" : [ "replication_session" ], | |
| "parameters" : [ ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/replication_session/{id}/failover" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the replication session.\n", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "replication_session" | |
| } ], | |
| "post" : { | |
| "description" : "Fail over a replication session instance. Failing over the replication session changes the role of the destination system. After a failover, the original destination system becomes the source system, and production access is enabled for hosts and applications for recovery. Failovers can be planned or unplanned. \n\n\n\n\nPlanned failovers are issued from the source system and are indicated by setting the is_planned parameter to true. When you fail over a replication session from the source system, the destination system is fully synchronized with the source to ensure that there is no data loss. During a planned failover, stop I/O operations for any applications and hosts. If a synchronization error occurs during a planned failover, the replication session enters the System_Paused state. You cannot pause a replication session during a planned failover. The following operations can be performed during planned failover:\n* Unplanned failover\n* Delete the replication session by removing the protection policy on the storage resource\n\n\n\n\nAfter a planned failover, the replication session is in an inactive state. You can use the reprotect action to synchronize the destination storage resource, and then resume the replication session. The auto-reprotect feature can also be used after a planned failover by using the reverse parameter, which activates the session in the reverse direction. \n\n\n\n\nUnplanned failures are events such as source system failure or an event on the source system that leads to downtime for production access.\n\n\n\n\nUnplanned 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. After an unplanned failover, you can restore the system from any point-in-time snapshots on the new source resource. Unplanned failovers place the original source resource into destination mode once it reestablishes a connection to the source system. You can use the reprotect action to synchronize the destination storage resource, and then resume the replication session.\n\n\n\n\nAfter the replication session has failed over, you can resize the volume group or change the volume group membership on the new source resource.\n", | |
| "summary" : "Failover", | |
| "tags" : [ "replication_session" ], | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/replication_session_failover" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/replication_session/{id}/reprotect" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the replication session.\n", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "replication_session" | |
| } ], | |
| "post" : { | |
| "description" : "Reprotect a replication session instance. Activates the replication session and starts synchronization. This can only be used when the session is in the has been failed over.\n", | |
| "summary" : "Reprotect", | |
| "tags" : [ "replication_session" ], | |
| "parameters" : [ ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/vcenter" : { | |
| "get" : { | |
| "tags" : [ "vcenter" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query registered vCenters.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/vcenter_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of vcenter instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/vcenter_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "vcenter" ], | |
| "summary" : "Create", | |
| "description" : "Add a vCenter. Not allowed in Unified+ deployments.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/vcenter_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/vcenter/{id}" : { | |
| "get" : { | |
| "tags" : [ "vcenter" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific vCenter instance.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the vCenter to query.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "vcenter" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/vcenter_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "vcenter" ], | |
| "summary" : "Modify", | |
| "description" : "Modify a vCenter settings.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the vCenter to modify.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "vcenter" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/vcenter_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "vcenter" ], | |
| "summary" : "Delete", | |
| "description" : "Delete a registered vCenter. Deletion of vCenter disables functionality that requires communication with vCenter. Not allowed in Unified+ deployments.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the vCenter to delete.", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "vcenter" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chap_config" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query the list of (one) CHAP configuration settings objects. \nThis resource type collection query does not support filtering, sorting or pagination", | |
| "x-simple_get" : true, | |
| "tags" : [ "chap_config" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/chap_config_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of chap config instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/chap_config_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chap_config/{id}" : { | |
| "get" : { | |
| "summary" : "Instance Query", | |
| "description" : "Query the CHAP configuration settings object.", | |
| "x-simple_get" : true, | |
| "tags" : [ "chap_config" ], | |
| "parameters" : [ { | |
| "in" : "path", | |
| "name" : "id", | |
| "description" : "The id of the CHAP configuration object (always \"0\").", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "chap_config" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/chap_config_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "chap_config" ], | |
| "summary" : "Modify", | |
| "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" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "The id of the CHAP configuration object (always \"0\").", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "chap_config" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/chap_config_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server" : { | |
| "get" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query all NAS servers.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/nas_server_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of nas server instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/nas_server_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Create", | |
| "description" : "Create a NAS server.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}" : { | |
| "get" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific NAS server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "x-ref" : "nas_server", | |
| "description" : "Unique identifier of the NAS server." | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Modify", | |
| "description" : "Modify the settings of a NAS server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Delete", | |
| "description" : "Delete a NAS server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_delete" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/ping" : { | |
| "post" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Ping an IP address", | |
| "description" : "Ping destination from NAS server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_ping" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/upload/passwd" : { | |
| "post" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Upload File", | |
| "description" : "Upload NAS server passwd file.", | |
| "consumes" : [ "multipart/form-data" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| }, { | |
| "in" : "formData", | |
| "name" : "body", | |
| "type" : "file", | |
| "description" : "Upload NAS server passwd file." | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/download/passwd" : { | |
| "get" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Download File", | |
| "description" : "Download a NAS server passwd file containing template or the actual (if already uploaded) passwd details.", | |
| "produces" : [ "document/text" ], | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_passwd_file" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/upload/hosts" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "post" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Upload File", | |
| "description" : "Upload NAS server host file.", | |
| "consumes" : [ "multipart/form-data" ], | |
| "parameters" : [ { | |
| "in" : "formData", | |
| "name" : "body", | |
| "type" : "file", | |
| "description" : "Upload NAS server host file." | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/download/hosts" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "get" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Download File", | |
| "description" : "Download an NAS server host file containing template/actual(if already uploaded) host details.", | |
| "produces" : [ "document/text" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_hosts_file" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/upload/group" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "post" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Upload File", | |
| "description" : "Upload NAS server group file.", | |
| "consumes" : [ "multipart/form-data" ], | |
| "parameters" : [ { | |
| "in" : "formData", | |
| "name" : "body", | |
| "type" : "file", | |
| "description" : "Upload NAS server group file." | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/download/group" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "get" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Download File", | |
| "description" : "Download a NAS server group file containing the template or the actual (if already uploaded) group details.", | |
| "produces" : [ "document/text" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_group_file" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/upload/netgroup" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "post" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Upload File", | |
| "description" : "Upload the NAS server netgroup file.", | |
| "consumes" : [ "multipart/form-data" ], | |
| "parameters" : [ { | |
| "in" : "formData", | |
| "name" : "body", | |
| "type" : "file", | |
| "description" : "Upload the NAS server netgroup file." | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/download/netgroup" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "get" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Download File", | |
| "description" : "Download an NAS server netgroup file containing the template or the actual (if already uploaded) netgroup details.", | |
| "produces" : [ "document/text" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_netgroup_file" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/upload/nsswitch" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "post" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Upload File", | |
| "description" : "Upload the NAS server nsswitch file.", | |
| "consumes" : [ "multipart/form-data" ], | |
| "parameters" : [ { | |
| "in" : "formData", | |
| "name" : "body", | |
| "type" : "file", | |
| "description" : "Upload the NAS server nsswitch file." | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/download/nsswitch" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "get" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Download File", | |
| "description" : "Download a NAS server nsswitch file containing the template or the actual (if already uploaded) nsswitch configuration settings.", | |
| "produces" : [ "document/text" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_nsswitch_file" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/upload/homedir" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "post" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Upload File", | |
| "description" : "Upload the NAS server homedir file.", | |
| "consumes" : [ "multipart/form-data" ], | |
| "parameters" : [ { | |
| "in" : "formData", | |
| "name" : "body", | |
| "type" : "file", | |
| "description" : "Upload the NAS server homedir file." | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/download/homedir" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "get" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Download File", | |
| "description" : "Download a NAS server homedir file containing the template or the actual (if already uploaded) homedir configuration settings.", | |
| "produces" : [ "document/text" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_homedir_file" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/upload/ntxmap" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "post" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Upload File", | |
| "consumes" : [ "multipart/form-data" ], | |
| "parameters" : [ { | |
| "in" : "formData", | |
| "name" : "body", | |
| "type" : "file", | |
| "description" : "Upload the NAS server ntxmap file." | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/download/ntxmap" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "get" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Download File", | |
| "description" : "Download an NAS server ntxmap file containing the template or the actual (if already uploaded) ntxmap configuration settings.", | |
| "produces" : [ "document/text" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_ntxmap_file" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/update_user_mappings" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "post" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Update User Mappings", | |
| "description" : "Fix the user mappings for all file systems associated with the NAS server. This process updates file ownership on the NAS server's file systems to reflect changes to users' SIDs. A new UID/GID will be obtained from a Unix Directory Service for the user name of the object owner. A user mapping report is also generated. This operation can take a significant amount of time, depending of the size of the file systems.", | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nas_server/{id}/download/user_mapping_report" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server.", | |
| "x-ref" : "nas_server" | |
| } ], | |
| "get" : { | |
| "tags" : [ "nas_server" ], | |
| "summary" : "Download User Mapping Report", | |
| "description" : "Download the report generated by the update_user_mappings action.\n", | |
| "produces" : [ "document/text" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/nas_server_user_mapping_report_file" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_interface" : { | |
| "get" : { | |
| "tags" : [ "file_interface" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query file interfaces.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_interface_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of file interface instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_interface_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "file_interface" ], | |
| "summary" : "Create", | |
| "description" : "Create a file interface.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_interface_create" | |
| }, | |
| "required" : true | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_interface/{id}" : { | |
| "get" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the file interface.", | |
| "x-ref" : "file_interface" | |
| } ], | |
| "tags" : [ "file_interface" ], | |
| "summary" : "Instance Query", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_interface_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "file_interface" ], | |
| "summary" : "Modify", | |
| "description" : "Modify the settings of a file interface.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the file interface.", | |
| "x-ref" : "file_interface" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/file_interface_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "file_interface" ], | |
| "summary" : "Delete", | |
| "description" : "Delete a file interface.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the file interface.", | |
| "x-ref" : "file_interface" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_ndmp" : { | |
| "get" : { | |
| "tags" : [ "file_ndmp" ], | |
| "summary" : "Collection Query", | |
| "description" : "List configured NDMP service instances.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_ndmp_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of file ndmp instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_ndmp_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "file_ndmp" ], | |
| "summary" : "Create", | |
| "description" : "Add an NDMP service configuration to a NAS server. Only one NDMP service object can be configured per NAS server.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_ndmp_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_ndmp/{id}" : { | |
| "get" : { | |
| "tags" : [ "file_ndmp" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query an NDMP service configuration instance.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NDMP service object.", | |
| "x-ref" : "file_ndmp" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_ndmp_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "file_ndmp" ], | |
| "summary" : "Modify", | |
| "description" : "Modify an NDMP service configuration instance.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NDMP service object.", | |
| "x-ref" : "file_ndmp" | |
| }, { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_ndmp_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "file_ndmp" ], | |
| "summary" : "Delete", | |
| "description" : "Delete an NDMP service configuration instance of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NDMP service object.", | |
| "x-ref" : "file_ndmp" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_virus_checker" : { | |
| "get" : { | |
| "tags" : [ "file_virus_checker" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query all virus checker settings of the NAS Servers.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_virus_checker_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of file virus checker instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_virus_checker_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "file_virus_checker" ], | |
| "summary" : "Create", | |
| "description" : "Add a new virus checker setting to a NAS Server. Only one instance can be created per NAS Server.\nWorkflow to enable the virus checker settings on the NAS Server is as follows: \\n\n1. Create a virus checker instance on NAS Server.\n2. Download template virus checker configuration file.\n3. Edit the configuration file with virus checker configuration details.\n4. Upload the configuration file.\n5. Enable the virus checker on the NAS Server.\n", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_virus_checker_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_virus_checker/{id}" : { | |
| "get" : { | |
| "tags" : [ "file_virus_checker" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific virus checker setting of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the virus checker instance.", | |
| "x-ref" : "file_virus_checker" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_virus_checker_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "file_virus_checker" ], | |
| "summary" : "Modify", | |
| "description" : "Modify the virus checker settings of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the virus checker instance.", | |
| "x-ref" : "file_virus_checker" | |
| }, { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_virus_checker_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "file_virus_checker" ], | |
| "summary" : "Delete", | |
| "description" : "Delete virus checker settings of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the virus checker instance.", | |
| "x-ref" : "file_virus_checker" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_virus_checker/{id}/upload_config" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the virus checker instance.", | |
| "x-ref" : "file_virus_checker" | |
| } ], | |
| "post" : { | |
| "tags" : [ "file_virus_checker" ], | |
| "summary" : "Upload Config File", | |
| "description" : "Upload a virus checker configuration file containing the virus checker configuration settings.", | |
| "consumes" : [ "multipart/form-data" ], | |
| "parameters" : [ { | |
| "in" : "formData", | |
| "name" : "body", | |
| "type" : "file", | |
| "description" : "Upload virus checker configuration file." | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_virus_checker/{id}/download_config" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the virus checker instance.", | |
| "x-ref" : "file_virus_checker" | |
| } ], | |
| "get" : { | |
| "tags" : [ "file_virus_checker" ], | |
| "summary" : "Download Config File", | |
| "description" : "Download a virus checker configuration file containing the template or the actual (if already uploaded) virus checker configuration settings.", | |
| "produces" : [ "document/text" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Ok", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_virus_checker_config_file" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nfs_server" : { | |
| "get" : { | |
| "tags" : [ "nfs_server" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query all NFS Servers.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success.", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/nfs_server_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of nfs server instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/nfs_server_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "nfs_server" ], | |
| "summary" : "Create", | |
| "description" : "Create an NFS server.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/nfs_server_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nfs_server/{id}" : { | |
| "get" : { | |
| "tags" : [ "nfs_server" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query settings of an NFS server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NFS server.", | |
| "x-ref" : "nfs_server" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/nfs_server_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "nfs_server" ], | |
| "summary" : "Modify", | |
| "description" : "Modify NFS server settings.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NFS server.", | |
| "x-ref" : "nfs_server" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/nfs_server_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "nfs_server" ], | |
| "summary" : "Delete", | |
| "description" : "Delete an NFS server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NFS server.", | |
| "x-ref" : "nfs_server" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : false, | |
| "schema" : { | |
| "$ref" : "#/definitions/nfs_server_delete" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nfs_server/{id}/join" : { | |
| "post" : { | |
| "tags" : [ "nfs_server" ], | |
| "summary" : "Join Active Directory (AD) Domain", | |
| "description" : "Join the secure NFS server to the NAS server's AD domain, which is necessary for Secure NFS.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NFS server.", | |
| "x-ref" : "nfs_server" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/nfs_server_join" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nfs_server/{id}/unjoin" : { | |
| "post" : { | |
| "tags" : [ "nfs_server" ], | |
| "summary" : "Unjoin Active Directory (AD) Domain", | |
| "description" : "Unjoin the secure NFS server from the NAS server's Active Directory domain. If you unjoin with secure NFS exports active, exports will be unavailable to the clients.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NFS server.", | |
| "x-ref" : "nfs_server" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/nfs_server_unjoin" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/smb_server" : { | |
| "get" : { | |
| "tags" : [ "smb_server" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query all SMB servers.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/smb_server_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of smb server instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/smb_server_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "smb_server" ], | |
| "summary" : "Create", | |
| "description" : "Create an SMB server.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/smb_server_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/smb_server/{id}" : { | |
| "get" : { | |
| "tags" : [ "smb_server" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query settings of a specific SMB server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the SMB server.", | |
| "x-ref" : "smb_server" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/smb_server_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "smb_server" ], | |
| "summary" : "Modify", | |
| "description" : "Modify an SMB server's settings.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the SMB server.", | |
| "x-ref" : "smb_server" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/smb_server_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "smb_server" ], | |
| "summary" : "Delete", | |
| "description" : "Delete a SMB server. The SMB server must not be joined to a domain to be deleted.\n", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the SMB server.", | |
| "x-ref" : "smb_server" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : false, | |
| "schema" : { | |
| "$ref" : "#/definitions/smb_server_delete" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/smb_server/{id}/join" : { | |
| "post" : { | |
| "tags" : [ "smb_server" ], | |
| "summary" : "Domain Join", | |
| "description" : "Join the SMB server to an Active Directory domain.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the SMB server.", | |
| "x-ref" : "smb_server" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/smb_server_join" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/smb_server/{id}/unjoin" : { | |
| "post" : { | |
| "tags" : [ "smb_server" ], | |
| "summary" : "Domain Unjoin", | |
| "description" : "Unjoin the SMB server from an Active Directory domain.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the SMB server.", | |
| "x-ref" : "smb_server" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/smb_server_unjoin" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_dns" : { | |
| "get" : { | |
| "tags" : [ "file_dns" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query of the DNS settings of NAS Servers.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success.", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_dns_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of file dns instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_dns_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "file_dns" ], | |
| "summary" : "Create", | |
| "description" : "Create a new DNS Server configuration for a NAS Server. Only one object can be created per NAS Server.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_dns_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_dns/{id}" : { | |
| "get" : { | |
| "tags" : [ "file_dns" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific DNS settings object of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the DNS object.", | |
| "x-ref" : "file_dns" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_dns_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "file_dns" ], | |
| "summary" : "Modify", | |
| "description" : "Modify the DNS settings of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the DNS object.", | |
| "x-ref" : "file_dns" | |
| }, { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_dns_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success." | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "file_dns" ], | |
| "summary" : "Delete", | |
| "description" : "Delete DNS settings of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the DNS object.", | |
| "x-ref" : "file_dns" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_ftp" : { | |
| "get" : { | |
| "tags" : [ "file_ftp" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query FTP/SFTP instances.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_ftp_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of file ftp instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_ftp_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "file_ftp" ], | |
| "summary" : "Create", | |
| "description" : "Create an FTP/SFTP server.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/file_ftp_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_ftp/{id}" : { | |
| "get" : { | |
| "tags" : [ "file_ftp" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific FTP/SFTP server for its settings.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the FTP/SFTP Server object.", | |
| "x-ref" : "file_ftp" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_ftp_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "file_ftp" ], | |
| "summary" : "Modify", | |
| "description" : "Modify an FTP/SFTP server settings.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the FTP/SFTP Server object.", | |
| "x-ref" : "file_ftp" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/file_ftp_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "file_ftp" ], | |
| "summary" : "Delete", | |
| "description" : "Delete an FTP/SFTP Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the FTP/SFTP Server object.", | |
| "x-ref" : "file_ftp" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_interface_route" : { | |
| "get" : { | |
| "tags" : [ "file_interface_route" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query file interface routes.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_interface_route_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of file interface route instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_interface_route_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "file_interface_route" ], | |
| "summary" : "Create", | |
| "description" : "Create and configure a new file interface route.\nThere are 3 route types Subnet, Default, and Host.\n* The default route establishes a static route to a default gateway. To create a default route, provide only the default gateway IP address.\n* The host route establishes a static route to a specific host. To create a host route, provide the IP address of the specific host in the destination field, and the gateway.\n* The subnet route establishes a static route to a particular subnet. To create a subnet route, provide the IP address of the target subnet in the destination, the prefix length for that subnet, and the gateway.\n", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/file_interface_route_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_interface_route/{id}" : { | |
| "get" : { | |
| "tags" : [ "file_interface_route" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific file interface route for details.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the file interface route object.", | |
| "x-ref" : "file_interface_route" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_interface_route_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "file_interface_route" ], | |
| "summary" : "Modify", | |
| "description" : "Modify file interface route settings.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the file interface route object.", | |
| "x-ref" : "file_interface_route" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_interface_route_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "file_interface_route" ], | |
| "summary" : "Delete", | |
| "description" : "Delete file interface route.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the file interface route object.", | |
| "x-ref" : "file_interface_route" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_kerberos" : { | |
| "get" : { | |
| "tags" : [ "file_kerberos" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query of the Kerberos service settings of NAS Servers.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success.", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_kerberos_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of file kerberos instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_kerberos_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "file_kerberos" ], | |
| "summary" : "Create", | |
| "description" : "Create a Kerberos configuration. The operation will fail if a Kerberos configuration already exists.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_kerberos_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_kerberos/{id}" : { | |
| "get" : { | |
| "tags" : [ "file_kerberos" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific Kerberos service settings of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Kerberos service object.", | |
| "x-ref" : "file_kerberos" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_kerberos_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "file_kerberos" ], | |
| "summary" : "Modify", | |
| "description" : "Modify the Kerberos service settings of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the Kerberos service object.", | |
| "x-ref" : "file_kerberos" | |
| }, { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_kerberos_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success." | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "file_kerberos" ], | |
| "summary" : "Delete", | |
| "description" : "Delete Kerberos configuration of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the Kerberos service object.", | |
| "x-ref" : "file_kerberos" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_kerberos/{id}/upload_keytab" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the Kerberos service object.", | |
| "x-ref" : "file_kerberos" | |
| } ], | |
| "post" : { | |
| "tags" : [ "file_kerberos" ], | |
| "summary" : "Upload Keytab File", | |
| "description" : "A keytab file is required for secure NFS service with a Linux or Unix Kerberos Key Distribution Center (KDC). The keytab file can be generated using the KDC server.", | |
| "consumes" : [ "multipart/form-data" ], | |
| "parameters" : [ { | |
| "in" : "formData", | |
| "name" : "body", | |
| "type" : "file" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_kerberos/{id}/download_keytab" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the Kerberos service object.", | |
| "x-ref" : "file_kerberos" | |
| } ], | |
| "get" : { | |
| "tags" : [ "file_kerberos" ], | |
| "summary" : "Download Keytab File", | |
| "description" : "Download previously uploaded keytab file for secure NFS service.", | |
| "produces" : [ "application/binary" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Ok", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_kerberos_keytab_file" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_ldap" : { | |
| "get" : { | |
| "tags" : [ "file_ldap" ], | |
| "summary" : "Collection Query", | |
| "description" : "List LDAP Service instances.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_ldap_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of file ldap instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_ldap_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "file_ldap" ], | |
| "summary" : "Create", | |
| "description" : "Create an LDAP service on a NAS Server. Only one LDAP Service object can be created per NAS Server.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "description" : "Name of the LDAP service to create.", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_ldap_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_ldap/{id}" : { | |
| "get" : { | |
| "tags" : [ "file_ldap" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific NAS Server's LDAP settings object.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the LDAP settings object.", | |
| "x-ref" : "file_ldap" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_ldap_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "file_ldap" ], | |
| "summary" : "Modify", | |
| "description" : "Modify a NAS Server's LDAP settings object.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the LDAP settings object id.", | |
| "x-ref" : "file_ldap" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/file_ldap_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "file_ldap" ], | |
| "summary" : "Delete", | |
| "description" : "Delete a NAS Server's LDAP settings.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "LDAP settings object Id.", | |
| "x-ref" : "file_ldap" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_ldap/{id}/upload_config" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the LDAP settings object.", | |
| "x-ref" : "file_ldap" | |
| } ], | |
| "post" : { | |
| "tags" : [ "file_ldap" ], | |
| "summary" : "Upload Config", | |
| "consumes" : [ "multipart/form-data" ], | |
| "parameters" : [ { | |
| "in" : "formData", | |
| "name" : "body", | |
| "type" : "file", | |
| "required" : true | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_ldap/{id}/download_config" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the LDAP settings object.", | |
| "x-ref" : "file_ldap" | |
| } ], | |
| "get" : { | |
| "tags" : [ "file_ldap" ], | |
| "summary" : "Download Config", | |
| "produces" : [ "document/text" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_ldap_config_file" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_ldap/{id}/upload_certificate" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the LDAP settings object.", | |
| "x-ref" : "file_ldap" | |
| } ], | |
| "post" : { | |
| "tags" : [ "file_ldap" ], | |
| "summary" : "Upload Certificate", | |
| "consumes" : [ "multipart/form-data" ], | |
| "parameters" : [ { | |
| "in" : "formData", | |
| "name" : "body", | |
| "type" : "file", | |
| "required" : true | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_ldap/{id}/download_certificate" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the LDAP settings object.", | |
| "x-ref" : "file_ldap" | |
| } ], | |
| "get" : { | |
| "tags" : [ "file_ldap" ], | |
| "summary" : "Download Certificate", | |
| "produces" : [ "document/text" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_ldap_certificate_file" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_nis" : { | |
| "get" : { | |
| "tags" : [ "file_nis" ], | |
| "summary" : "Collection Query", | |
| "description" : "Query the NIS settings of NAS Servers.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success.", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_nis_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of file nis instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_nis_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "file_nis" ], | |
| "summary" : "Create", | |
| "description" : "Create a new NIS Service on a NAS Server. Only one NIS Setting object can be created per NAS Server.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_nis_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_nis/{id}" : { | |
| "get" : { | |
| "tags" : [ "file_nis" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific NIS settings object of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NIS object.", | |
| "x-ref" : "file_nis" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_nis_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "file_nis" ], | |
| "summary" : "Modify", | |
| "description" : "Modify the NIS settings of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NIS object.", | |
| "x-ref" : "file_nis" | |
| }, { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_nis_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success." | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "file_nis" ], | |
| "summary" : "Delete", | |
| "description" : "Delete NIS settings of a NAS Server.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the NIS object.", | |
| "x-ref" : "file_nis" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_system" : { | |
| "get" : { | |
| "tags" : [ "file_system" ], | |
| "summary" : "Collection Query", | |
| "description" : "List file systems.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_system_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of file system instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_system_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "file_system" ], | |
| "summary" : "Create", | |
| "description" : "Create a file system.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_system_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_system/{id}" : { | |
| "get" : { | |
| "tags" : [ "file_system" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a specific file system.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "File system id.", | |
| "x-ref" : "file_system" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_system_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "file_system" ], | |
| "summary" : "Modify", | |
| "description" : "Modify a file system.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "File system id.", | |
| "x-ref" : "file_system" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/file_system_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "file_system" ], | |
| "summary" : "Delete", | |
| "description" : "Delete a file system.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "File system id.", | |
| "x-ref" : "file_system" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_system/{id}/clone" : { | |
| "post" : { | |
| "tags" : [ "file_system" ], | |
| "summary" : "Clone", | |
| "description" : "Create a clone of a file system.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "File system id.", | |
| "x-ref" : "file_system" | |
| }, { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_system_clone" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_system_clone_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_system/{id}/snapshot" : { | |
| "post" : { | |
| "tags" : [ "file_system" ], | |
| "summary" : "Snapshot", | |
| "description" : "Create a snapshot of a file system.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "File system id.", | |
| "x-ref" : "file_system" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_system_snapshot" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_system_snapshot_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_system/{id}/refresh" : { | |
| "post" : { | |
| "tags" : [ "file_system" ], | |
| "summary" : "Refresh", | |
| "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" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "File system snapshot id.", | |
| "x-ref" : "file_system" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_system/{id}/restore" : { | |
| "post" : { | |
| "tags" : [ "file_system" ], | |
| "summary" : "Restore", | |
| "description" : "Restore from a snapshot of a file system.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "File system snapshot id.", | |
| "x-ref" : "file_system" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_system_restore" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success (with backup snapshot)", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_system_restore_response" | |
| } | |
| }, | |
| "204" : { | |
| "description" : "Success (without backup snapshot)" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_system/{id}/refresh_quota" : { | |
| "post" : { | |
| "tags" : [ "file_system" ], | |
| "summary" : "Refresh Quota", | |
| "description" : "Refresh the actual content of tree and user quotas objects.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "File system id.", | |
| "x-ref" : "file_system" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_tree_quota" : { | |
| "get" : { | |
| "tags" : [ "file_tree_quota" ], | |
| "summary" : "Collection Query", | |
| "description" : "List tree quota instances.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_tree_quota_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of file tree quota instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_tree_quota_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "file_tree_quota" ], | |
| "summary" : "Create", | |
| "description" : "Create a tree quota instance.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_tree_quota_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_tree_quota/{id}" : { | |
| "get" : { | |
| "tags" : [ "file_tree_quota" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a tree quota instance.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the tree quota.", | |
| "x-ref" : "file_tree_quota" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_tree_quota_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "file_tree_quota" ], | |
| "summary" : "Modify", | |
| "description" : "Modify a tree quota instance.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the tree quota.", | |
| "x-ref" : "file_tree_quota" | |
| }, { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_tree_quota_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "file_tree_quota" ], | |
| "summary" : "Delete", | |
| "description" : "Delete a tree quota instance.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the tree quota.", | |
| "x-ref" : "file_tree_quota" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_tree_quota/{id}/refresh" : { | |
| "post" : { | |
| "tags" : [ "file_tree_quota" ], | |
| "summary" : "Refresh", | |
| "description" : "Refresh the cache with the actual value of the tree quota.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the tree quota.", | |
| "x-ref" : "file_tree_quota" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_user_quota" : { | |
| "get" : { | |
| "tags" : [ "file_user_quota" ], | |
| "summary" : "Collection Query", | |
| "description" : "List user quota instances.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_user_quota_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of file user quota instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_user_quota_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "file_user_quota" ], | |
| "summary" : "Create", | |
| "description" : "Create a user quota instance.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_user_quota_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_user_quota/{id}" : { | |
| "get" : { | |
| "tags" : [ "file_user_quota" ], | |
| "summary" : "Instance Query", | |
| "description" : "Query a user quota instance.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the file user quota.", | |
| "x-ref" : "file_user_quota" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_user_quota_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "file_user_quota" ], | |
| "summary" : "Modify", | |
| "description" : "Modify a user quota instance.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the file user quota.", | |
| "x-ref" : "file_user_quota" | |
| }, { | |
| "name" : "body", | |
| "required" : true, | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/file_user_quota_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/file_user_quota/{id}/refresh" : { | |
| "post" : { | |
| "tags" : [ "file_user_quota" ], | |
| "summary" : "Refresh", | |
| "description" : "Refresh the cache with the actual value of the user quota.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "Unique identifier of the file user quota.", | |
| "x-ref" : "file_user_quota" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nfs_export" : { | |
| "get" : { | |
| "tags" : [ "nfs_export" ], | |
| "summary" : "Collection Query", | |
| "description" : "List NFS Exports.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/nfs_export_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of nfs export instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/nfs_export_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "nfs_export" ], | |
| "summary" : "Create", | |
| "description" : "Create an NFS Export for a Snapshot.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/nfs_export_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/nfs_export/{id}" : { | |
| "get" : { | |
| "tags" : [ "nfs_export" ], | |
| "summary" : "Instance Query", | |
| "description" : "Get NFS Export properties.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "NFS Export object id.", | |
| "x-ref" : "nfs_export" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/nfs_export_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "nfs_export" ], | |
| "summary" : "Modify", | |
| "description" : "Modify NFS Export Properties.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "NFS Export object id.", | |
| "x-ref" : "nfs_export" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/nfs_export_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "nfs_export" ], | |
| "summary" : "Delete", | |
| "description" : "Delete NFS Export.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "NFS Export object id.", | |
| "x-ref" : "nfs_export" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/smb_share" : { | |
| "get" : { | |
| "tags" : [ "smb_share" ], | |
| "summary" : "Collection Query", | |
| "description" : "List SMB shares.", | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/smb_share_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of smb share instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/smb_share_instance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "smb_share" ], | |
| "summary" : "Create", | |
| "description" : "Create an SMB share.", | |
| "parameters" : [ { | |
| "name" : "body", | |
| "in" : "body", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/smb_share_create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "schema" : { | |
| "$ref" : "#/definitions/create_response" | |
| } | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/smb_share/{id}" : { | |
| "get" : { | |
| "tags" : [ "smb_share" ], | |
| "summary" : "Instance Query", | |
| "description" : "Get an SMB Share.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "SMB Share object id.", | |
| "x-ref" : "smb_share" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/smb_share_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "smb_share" ], | |
| "summary" : "Modify", | |
| "description" : "Modify SMB share properties.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "SMB share object id.", | |
| "x-ref" : "smb_share" | |
| }, { | |
| "name" : "body", | |
| "in" : "body", | |
| "schema" : { | |
| "$ref" : "#/definitions/smb_share_modify" | |
| } | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "400" : { | |
| "description" : "Invalid Request", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "smb_share" ], | |
| "summary" : "Delete", | |
| "description" : "Delete an SMB Share.", | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "required" : true, | |
| "type" : "string", | |
| "description" : "SMB Share object id.", | |
| "x-ref" : "smb_share" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Success" | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| }, | |
| "422" : { | |
| "description" : "Operation Failed", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/host_virtual_volume_mapping" : { | |
| "get" : { | |
| "summary" : "Collection Query", | |
| "description" : "Query associations between a virtual volume and the host(s) it is attached to.", | |
| "tags" : [ "host_virtual_volume_mapping" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_virtual_volume_mapping_instance" | |
| } | |
| } | |
| }, | |
| "206" : { | |
| "description" : "Partial content of host virtual volume mapping instance objects", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_virtual_volume_mapping_instance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/host_virtual_volume_mapping/{id}" : { | |
| "parameters" : [ { | |
| "name" : "id", | |
| "in" : "path", | |
| "description" : "Unique identifier of the virtual volume mapping.", | |
| "type" : "string", | |
| "required" : true, | |
| "x-ref" : "host_virtual_volume_mapping" | |
| } ], | |
| "get" : { | |
| "description" : "Query a specific virtual volume mapping.", | |
| "summary" : "Instance Query", | |
| "tags" : [ "host_virtual_volume_mapping" ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "Success", | |
| "schema" : { | |
| "$ref" : "#/definitions/host_virtual_volume_mapping_instance" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Not Found", | |
| "schema" : { | |
| "$ref" : "#/definitions/error_response" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "definitions" : { | |
| "create_response" : { | |
| "type" : "object", | |
| "description" : "Create response for an operation.", | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the new instance created." | |
| } | |
| } | |
| }, | |
| "MessageSeverityEnum" : { | |
| "description" : "Message severity.", | |
| "type" : "string", | |
| "enum" : [ "Info", "Warning", "Error" ] | |
| }, | |
| "error_message" : { | |
| "type" : "object", | |
| "description" : "Error message for an operation.", | |
| "properties" : { | |
| "code" : { | |
| "type" : "string", | |
| "description" : "Hexadecimal error code of the message." | |
| }, | |
| "severity" : { | |
| "$ref" : "#/definitions/MessageSeverityEnum" | |
| }, | |
| "message_l10n" : { | |
| "type" : "string", | |
| "description" : "The message description in the specified locale with arguments substituted." | |
| }, | |
| "arguments" : { | |
| "type" : "array", | |
| "description" : "Arguments (if applicable) for the error message.", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| }, | |
| "error_response" : { | |
| "type" : "object", | |
| "description" : "Error response for an operation. Contains an array of localized messages.", | |
| "properties" : { | |
| "messages" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/error_message" | |
| } | |
| } | |
| } | |
| }, | |
| "job_response" : { | |
| "type" : "object", | |
| "description" : "Job response for an asynchronous request. The response to any asynchronous request that does not fail immediately.", | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "The id of the job created by the request." | |
| } | |
| } | |
| }, | |
| "base_response" : { | |
| "type" : "object", | |
| "description" : "Base response object \nFiltering on the fields of this embedded resource is not supported.", | |
| "discriminator" : "response_type", | |
| "required" : [ "response_type" ], | |
| "properties" : { | |
| "response_type" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "x-no_filter" : true | |
| }, | |
| "appliance_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "service_tag", "model", "software_installed.release_version" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the appliance.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "Name of the appliance. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "service_tag" : { | |
| "description" : "Dell Service Tag.", | |
| "type" : "string" | |
| }, | |
| "express_service_code" : { | |
| "description" : "Express Service Code.", | |
| "type" : "string" | |
| }, | |
| "model" : { | |
| "description" : "Model of the appliance.", | |
| "type" : "string" | |
| }, | |
| "nodes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/node_instance", | |
| "x-ref" : "node_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type node association." | |
| }, | |
| "ip_pool_addresses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ip_pool_address_instance", | |
| "x-ref" : "ip_pool_address_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type ip_pool_address association." | |
| }, | |
| "veth_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/veth_port_instance", | |
| "x-ref" : "veth_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type veth_port association." | |
| }, | |
| "maintenance_windows" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/maintenance_window_instance", | |
| "x-ref" : "maintenance_window_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type maintenance_window association." | |
| }, | |
| "fc_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/fc_port_instance", | |
| "x-ref" : "fc_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type fc_port association." | |
| }, | |
| "sas_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/sas_port_instance", | |
| "x-ref" : "sas_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type sas_port association." | |
| }, | |
| "eth_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/eth_port_instance", | |
| "x-ref" : "eth_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type eth_port association." | |
| }, | |
| "software_installed" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/software_installed_instance", | |
| "x-ref" : "software_installed_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type software_installed association." | |
| }, | |
| "virtual_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/virtual_volume_instance", | |
| "x-ref" : "virtual_volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type virtual_volume association." | |
| }, | |
| "hardware" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/hardware_instance", | |
| "x-ref" : "hardware_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type hardware association." | |
| }, | |
| "volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/volume_instance", | |
| "x-ref" : "volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type volume association." | |
| } | |
| }, | |
| "description" : "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" | |
| }, | |
| "appliance_modify" : { | |
| "type" : "object", | |
| "description" : "Appliance modify request body.", | |
| "required" : [ "name" ], | |
| "properties" : { | |
| "name" : { | |
| "description" : "New name of the appliance.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "audit_event_instance" : { | |
| "type" : "object", | |
| "title" : "audit_event_instance", | |
| "x-select_cli" : [ "id", "type", "timestamp", "message_l10n", "appliance_id", "resource_type", "resource_action", "message_l10n" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the audit log entry.", | |
| "type" : "string" | |
| }, | |
| "type" : { | |
| "$ref" : "#/definitions/AuditEventTypeEnum" | |
| }, | |
| "timestamp" : { | |
| "description" : "Time the event occurred to one second precision.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "username" : { | |
| "description" : "Fully qualified name of the user who initiated the event to be audited. For example, domain_name/name.", | |
| "type" : "string" | |
| }, | |
| "is_successful" : { | |
| "description" : "Whether the event was successful or not.", | |
| "type" : "boolean" | |
| }, | |
| "client_address" : { | |
| "description" : "FQDN/IP Address of the client from where the event was initiated.", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "server_address" : { | |
| "description" : "IP Address on which the request was targeted.", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "appliance_id" : { | |
| "description" : "Unique identifier of the appliance where the event occurred.", | |
| "type" : "string" | |
| }, | |
| "job_id" : { | |
| "description" : "Unique identifier of the job associated with the audit event (if any).", | |
| "type" : "string" | |
| }, | |
| "resource_type" : { | |
| "$ref" : "#/definitions/ResourceTypeEnum" | |
| }, | |
| "resource_action" : { | |
| "$ref" : "#/definitions/ResourceActionEnum" | |
| }, | |
| "message_code" : { | |
| "description" : "Unique identifier of the message for this audit_event.", | |
| "type" : "string" | |
| }, | |
| "message_arguments" : { | |
| "description" : "Arguments (if applicable) for the audit_event message.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "message_l10n" : { | |
| "description" : "Localized message string corresponding to message_code.", | |
| "type" : "string" | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "resource_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to resource_type" | |
| }, | |
| "resource_action_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to resource_action" | |
| } | |
| } | |
| }, | |
| "AuditEventTypeEnum" : { | |
| "type" : "string", | |
| "title" : "AuditEventTypeEnum", | |
| "description" : "Type of audit event.\n 1. Authentication: All the authentication events on the system.\n 2. Authorization: All the authorization events on the system.\n 3. Config: All the set operations on the system. Example: POST, PATCH, DELETE.\n 4. System: All the system level operations.\n 5. Logout: All the logging out events on the system.", | |
| "enum" : [ "Authentication", "Authorization", "Config", "System", "Logout" ], | |
| "x-display_enum_text" : { | |
| "Authentication" : "Authentication", | |
| "Authorization" : "Authorization", | |
| "Config" : "Config", | |
| "System" : "System", | |
| "Logout" : "Logout" | |
| } | |
| }, | |
| "node_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "slot", "appliance_id", "appliance.name", "appliance.service_tag" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the node.", | |
| "type" : "string" | |
| }, | |
| "slot" : { | |
| "description" : "Slot number of the node.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "appliance_id" : { | |
| "description" : "Unique identifier of the appliance to which the node belongs.", | |
| "type" : "string" | |
| }, | |
| "appliance" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/appliance_instance", | |
| "description" : "This is the embeddable reference form of appliance_id attribute.", | |
| "x-ref" : "appliance" | |
| }, | |
| "ip_pool_addresses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ip_pool_address_instance", | |
| "x-ref" : "ip_pool_address_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type ip_pool_address association." | |
| }, | |
| "veth_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/veth_port_instance", | |
| "x-ref" : "veth_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type veth_port association." | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from appliance, ip_pool_address, veth_port" | |
| }, | |
| "event_instance" : { | |
| "type" : "object", | |
| "description" : "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.", | |
| "x-select_cli" : [ "id", "severity", "resource_type", "resource_name", "generated_timestamp", "description_l10n" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of this occurrence of an event.", | |
| "type" : "string" | |
| }, | |
| "event_code" : { | |
| "description" : "Identifies the specific kind of event that has occurred.", | |
| "type" : "string" | |
| }, | |
| "severity" : { | |
| "description" : "The severity of the event.", | |
| "$ref" : "#/definitions/SeverityEnum" | |
| }, | |
| "resource_type" : { | |
| "description" : "The type of the object which generated this event.", | |
| "$ref" : "#/definitions/ResourceTypeEnum" | |
| }, | |
| "resource_id" : { | |
| "description" : "Unique identifier of the resource instance which generated this event.", | |
| "type" : "string" | |
| }, | |
| "resource_name" : { | |
| "description" : "Name of the resource instance which generated this event. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "generated_timestamp" : { | |
| "format" : "date-time", | |
| "description" : "Timestamp at which this event occured.", | |
| "type" : "string" | |
| }, | |
| "description_l10n" : { | |
| "description" : "Description of this event.", | |
| "type" : "string" | |
| }, | |
| "system_impact_l10n" : { | |
| "description" : "Describes the possible effect on the system of this event.", | |
| "type" : "string" | |
| }, | |
| "repair_flow_l10n" : { | |
| "description" : "Suggestions for how to resolve any problems that may arise from this event.", | |
| "type" : "string" | |
| }, | |
| "severity_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to severity" | |
| }, | |
| "resource_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to resource_type" | |
| } | |
| } | |
| }, | |
| "NetworkTypeEnum" : { | |
| "description" : "Network type.", | |
| "type" : "string", | |
| "enum" : [ "Management", "Intra_Cluster_Management", "Intra_Cluster_Data", "Storage", "VMotion" ], | |
| "x-display_enum_text" : { | |
| "Management" : "Management", | |
| "Intra_Cluster_Management" : "Intra Cluster Management", | |
| "Intra_Cluster_Data" : "Intra Cluster Data", | |
| "Storage" : "Storage", | |
| "VMotion" : "vMotion" | |
| } | |
| }, | |
| "IpVersionTypeEnum" : { | |
| "description" : "IP protocol version.", | |
| "type" : "string", | |
| "enum" : [ "IPv4", "IPv6" ], | |
| "x-display_enum_text" : { | |
| "IPv4" : "IPv4", | |
| "IPv6" : "IPv6" | |
| } | |
| }, | |
| "IpPurposeTypeEnum" : { | |
| "description" : "Network IP address purpose.", | |
| "type" : "string", | |
| "enum" : [ "Mgmt_Cluster_Floating", "Mgmt_Appliance_Floating", "Mgmt_Node_CoreOS", "Mgmt_Node_Host", "ICM_Cluster_Floating", "ICM_Appliance_Floating", "ICM_Node_CoreOS", "Storage_Global", "Storage_Iscsi_Initiator", "Storage_Iscsi_Target", "Storage_Cluster_Floating", "ICD_Node", "SDNAS_Cluster_Floating", "SDNAS_Node", "SDNAS_Node_Serviceability", "VMotion", "Unused" ], | |
| "x-display_enum_text" : { | |
| "Mgmt_Cluster_Floating" : "Mgmt_Cluster_Floating", | |
| "Mgmt_Appliance_Floating" : "Mgmt_Appliance_Floating", | |
| "Mgmt_Node_CoreOS" : "Mgmt_Node_CoreOS", | |
| "Mgmt_Node_Host" : "Mgmt_Node_Host", | |
| "ICM_Cluster_Floating" : "ICM_Cluster_Floating", | |
| "ICM_Appliance_Floating" : "ICM_Appliance_Floating", | |
| "ICM_Node_CoreOS" : "ICM_Node_CoreOS", | |
| "Storage_Global" : "Storage_Global", | |
| "Storage_Iscsi_Initiator" : "Storage_Iscsi_Initiator", | |
| "Storage_Iscsi_Target" : "Storage_Iscsi_Target", | |
| "Storage_Cluster_Floating" : "Storage_Cluster_Floating", | |
| "ICD_Node" : "ICD_Node", | |
| "SDNAS_Cluster_Floating" : "SDNAS_Cluster_Floating", | |
| "SDNAS_Node" : "SDNAS_Node", | |
| "SDNAS_Node_Serviceability" : "SDNAS_Node_Serviceability", | |
| "VMotion" : "VMotion", | |
| "Unused" : "Unused" | |
| } | |
| }, | |
| "IpPortUsageEnum" : { | |
| "description" : "IP port usages.\n* Management - Can be used for the public management network.\n* ISCSI - Can be used for the public storage network.\n* ISCSI_Default - Is used for default storage connections and cannot be uscaled.\n* External_Replication - Can be used for the external data mobility traffic.\n", | |
| "type" : "string", | |
| "enum" : [ "Management", "ISCSI", "ISCSI_Default", "External_Replication" ], | |
| "x-display_enum_text" : { | |
| "Management" : "Management", | |
| "ISCSI" : "iSCSI", | |
| "ISCSI_Default" : "iSCSI Default", | |
| "External_Replication" : "External Replication" | |
| } | |
| }, | |
| "BondingModeEnum" : { | |
| "description" : "Bond mode.\n* LACP - Uses an IEEE 802.3ad dynamic link aggregation policy. Aggregation groups share the same speed and duplex settings. This mode transmits and receives network traffic on all slaves in the active aggregator.\n", | |
| "type" : "string", | |
| "enum" : [ "LACP" ], | |
| "x-display_enum_text" : { | |
| "LACP" : "LACP" | |
| } | |
| }, | |
| "network_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "type", "vlan_id", "gateway", "mtu", "ip_pool_addresses.address", "ip_pool_addresses.purposes" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the network.", | |
| "type" : "string" | |
| }, | |
| "type" : { | |
| "$ref" : "#/definitions/NetworkTypeEnum" | |
| }, | |
| "ip_version" : { | |
| "$ref" : "#/definitions/IpVersionTypeEnum" | |
| }, | |
| "vlan_id" : { | |
| "description" : "VLAN identifier.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 4094 | |
| }, | |
| "prefix_length" : { | |
| "description" : "Network prefix length, used for both IPv4 and IPv6.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 1, | |
| "maximum" : 127 | |
| }, | |
| "gateway" : { | |
| "description" : "Network gateway in IPv4 or IPv6 format, corresponding to the network's IP version.", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "mtu" : { | |
| "description" : "Maximum Transmission Unit (MTU) packet size set on network interfaces, in bytes.", | |
| "minimum" : 1280, | |
| "maximum" : 9000, | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "ip_version_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to ip_version" | |
| }, | |
| "ip_pool_addresses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ip_pool_address_instance", | |
| "x-ref" : "ip_pool_address_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type ip_pool_address association." | |
| } | |
| }, | |
| "description" : "This resource type has queriable association from ip_pool_address" | |
| }, | |
| "network_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "vlan_id" : { | |
| "description" : "VLAN identifier.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 4094 | |
| }, | |
| "gateway" : { | |
| "description" : "Network gateway in IPv4 or IPv6 format, corresponding to the network's IP version.\nSpecify empty string to remove the gateway.\n", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "prefix_length" : { | |
| "description" : "Network prefix length. (Used for both IPv4 and IPv6).", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 1, | |
| "maximum" : 127 | |
| }, | |
| "cluster_mgmt_address" : { | |
| "description" : "New cluster management IP address in IPv4 or IPv6 format, corresponding to the network's IP version.\nThis can only be specified when reconfiguring the management network.\n\nCaution: Changing the cluster management IP address will lead to losing management sessions through this address.\n", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "storage_discovery_address" : { | |
| "description" : "New storage discovery IP address in IPv4 or IPv6 format, corresponding to the network's IP version.\nThis can only be specified when reconfiguring the storage network.\nSpecify empty string to remove the storage discovery IP address.\n", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "vasa_provider_credentials" : { | |
| "description" : "Credentials required for re-registering the VASA vendor provider during the reconfiguration of the cluster management IP address.\nShould be passed only when reconfiguring cluster management IP address.\n", | |
| "type" : "object", | |
| "properties" : { | |
| "username" : { | |
| "description" : "VASA vendor provider user name.", | |
| "type" : "string" | |
| }, | |
| "password" : { | |
| "description" : "VASA vendor provider password.", | |
| "type" : "string", | |
| "format" : "password" | |
| } | |
| } | |
| }, | |
| "esxi_credentials" : { | |
| "$ref" : "#/definitions/esxi_credentials" | |
| }, | |
| "mtu" : { | |
| "description" : "Maximum Transmission Unit (MTU) packet size set on network interfaces, in bytes.", | |
| "minimum" : 1280, | |
| "maximum" : 9000, | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "add_addresses" : { | |
| "description" : "IP addresses to add in IPv4 or IPv6 format.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "format" : "ip-address" | |
| } | |
| }, | |
| "remove_addresses" : { | |
| "description" : "IP addresses to remove in IPv4 or IPv6 format.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "format" : "ip-address" | |
| } | |
| }, | |
| "force" : { | |
| "description" : "Indicates whether to suppress network validation errors.\nThe option is intended to suppress false errors caused by network environment constraints.\n\nNormally the command will fail with an error when:\n- some of system network ports are in degraded state or have cabling issues,\n- system top-of-rack switches have configuration issues leading to network unreachability,\n- network IP addresses have duplicates in the network environment,\n- or network gateway is unreachable.\n\nWhen force is true, the command will proceed instead.\n\nCaution: Only use this option when you are certain your requested settings are correct and you understand why they are failing at this time, and you want to apply the settings anyway.\nImproper network settings can make the system unreachable for data and management.\n", | |
| "type" : "boolean", | |
| "default" : false | |
| } | |
| } | |
| }, | |
| "network_scale" : { | |
| "type" : "object", | |
| "properties" : { | |
| "add_port_ids" : { | |
| "description" : "Unique identifiers of available IP ports to be used in the network.\n", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "remove_port_ids" : { | |
| "description" : "Unique identifiers of IP ports to remove from use in the network.\n", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "force" : { | |
| "description" : "Indicates whether to suppress network validation errors.\nThe option is intended to suppress false errors caused by network environment constraints.\n\nNormally the command will fail with an error when:\n* system network ports on top of which IP ports are configured are in degraded state or have cabling issues,\n* or network IP addresses applied as a result of network scaling have duplicates in the network environment.\n\nWhen force is true, the command will proceed instead.\n\nCaution: Only use this option when you are certain your requested settings are correct and you understand why they are failing at this time, and you want to apply the settings anyway.\nImproper network settings can make the system unreachable for data.\n", | |
| "type" : "boolean", | |
| "default" : false | |
| } | |
| } | |
| }, | |
| "network_replace" : { | |
| "type" : "object", | |
| "required" : [ "vlan_id", "gateway", "prefix_length", "cluster_mgmt_address", "mtu", "ip_pool_addresses", "dns_addresses", "ntp_addresses" ], | |
| "properties" : { | |
| "vlan_id" : { | |
| "description" : "VLAN identifier.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 4094 | |
| }, | |
| "gateway" : { | |
| "description" : "Network gateway in IPv4 or IPv6 format, corresponding to the network's IP version.\nSpecify empty string to remove the gateway.\n", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "prefix_length" : { | |
| "description" : "Network prefix length. (Used for both IPv4 and IPv6).", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 1, | |
| "maximum" : 127 | |
| }, | |
| "cluster_mgmt_address" : { | |
| "description" : "New cluster management IP address in IPv4 or IPv6 format, corresponding to the network's IP version.", | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "minLength" : 1 | |
| }, | |
| "vasa_provider_credentials" : { | |
| "description" : "Credentials required for re-registering the VASA vendor provider during the replacement of the cluster management IP address.\nShould be passed only when reconfiguring PowerStoreX cluster.\n", | |
| "type" : "object", | |
| "properties" : { | |
| "username" : { | |
| "description" : "VASA vendor provider user name.", | |
| "type" : "string" | |
| }, | |
| "password" : { | |
| "description" : "VASA vendor provider password.", | |
| "type" : "string", | |
| "format" : "password" | |
| } | |
| } | |
| }, | |
| "esxi_credentials" : { | |
| "$ref" : "#/definitions/esxi_credentials" | |
| }, | |
| "mtu" : { | |
| "description" : "Maximum Transmission Unit (MTU) packet size set on network interfaces, in bytes.", | |
| "minimum" : 1280, | |
| "maximum" : 9000, | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "ip_pool_addresses" : { | |
| "description" : "List of new IP addresses in IPv4 or IPv6 format.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "minLength" : 1 | |
| } | |
| }, | |
| "dns_addresses" : { | |
| "description" : "List of new DNS server IP addresses in IPv4 or IPv6 format.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "minLength" : 1 | |
| } | |
| }, | |
| "ntp_addresses" : { | |
| "description" : "List of new NTP server FQDNs or IP addresses in IPv4 or IPv6 format.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "minLength" : 1 | |
| } | |
| }, | |
| "vcenter_address" : { | |
| "description" : "New vCenter FQDNs or IP address in IPv4 or IPv6 format. Required only when reconfiguring PowerStoreX cluster.", | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "minLength" : 1 | |
| }, | |
| "smtp_config" : { | |
| "$ref" : "#/definitions/network_replace_smtp_config" | |
| }, | |
| "physical_switches" : { | |
| "description" : "List of new physical switches settings. If this property is omitted, physical switches configuration will not be modified.", | |
| "type" : "array", | |
| "maxItems" : 16, | |
| "items" : { | |
| "$ref" : "#/definitions/network_replace_physical_switch" | |
| } | |
| }, | |
| "force" : { | |
| "description" : "Indicates whether to suppress network validation errors.\nThe option is intended to suppress false errors caused by network environment constraints.\n\nNormally the command will fail with an error when:\n- some of system network ports are in degraded state or have cabling issues,\n- system top-of-rack switches have configuration issues leading to network unreachability,\n- network IP addresses have duplicates in the network environment,\n- or network gateway is unreachable.\n\nWhen force is true, the command will proceed instead.\n\nCaution: Only use this option when you are certain your requested settings are correct and you understand why they are failing at this time, and you want to apply the settings anyway.\nImproper network settings can make the system unreachable for data and management.\n", | |
| "type" : "boolean", | |
| "default" : false | |
| } | |
| } | |
| }, | |
| "network_replace_smtp_config" : { | |
| "type" : "object", | |
| "required" : [ "address", "port", "source_email" ], | |
| "properties" : { | |
| "address" : { | |
| "description" : "IP address of the SMTP server.", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "port" : { | |
| "description" : "Port used for sending SMTP messages.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "maximum" : 65535, | |
| "minimum" : 0 | |
| }, | |
| "source_email" : { | |
| "description" : "Source email address used for sending SMTP messages.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "network_replace_physical_switch" : { | |
| "type" : "object", | |
| "properties" : { | |
| "name" : { | |
| "description" : "Name of a physical switch.", | |
| "type" : "string" | |
| }, | |
| "purpose" : { | |
| "$ref" : "#/definitions/PhysicalSwitchPurposeEnum" | |
| }, | |
| "connections" : { | |
| "description" : "Supported connections for a physical switch.", | |
| "type" : "array", | |
| "maxItems" : 2, | |
| "items" : { | |
| "$ref" : "#/definitions/network_replace_physical_switch_connection" | |
| } | |
| } | |
| } | |
| }, | |
| "network_replace_physical_switch_connection" : { | |
| "type" : "object", | |
| "required" : [ "address", "connect_method" ], | |
| "properties" : { | |
| "address" : { | |
| "description" : "Physical switch address in IPv4 or IPv6 or DNS hostname format.", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "port" : { | |
| "description" : "Port used for connection to switch.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 65535 | |
| }, | |
| "connect_method" : { | |
| "$ref" : "#/definitions/PhysicalSwitchConnectMethodEnum" | |
| }, | |
| "username" : { | |
| "description" : "Username to connect a physical switch for SSH connection method.", | |
| "type" : "string" | |
| }, | |
| "ssh_password" : { | |
| "description" : "SSH password to connect a physical switch if SSH connect method is specified.", | |
| "type" : "string", | |
| "format" : "password" | |
| }, | |
| "snmp_community_string" : { | |
| "description" : "SNMPv2 community string, if SNMPv2c connect method is specified.", | |
| "type" : "string", | |
| "format" : "password" | |
| } | |
| } | |
| }, | |
| "esxi_credentials" : { | |
| "description" : "Credentials required for re-registering the ESXi hosts in the vCenter.\nShould be passed only when ESXi host addresses or management network VLAN / prefix / gateway are changed\nduring the reconfiguration of the PowerStore X model appliances.\n", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "object", | |
| "properties" : { | |
| "node_id" : { | |
| "description" : "Node identifier corresponding to the ESXi host.", | |
| "type" : "string" | |
| }, | |
| "password" : { | |
| "description" : "ESXi host root password.", | |
| "type" : "string", | |
| "format" : "password" | |
| } | |
| } | |
| } | |
| }, | |
| "ip_pool_address_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "network_id", "ip_port_id", "appliance_id", "node_id", "address", "purposes" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the IP address.", | |
| "type" : "string" | |
| }, | |
| "network_id" : { | |
| "description" : "Unique identifier of the network to which the IP address belongs.", | |
| "type" : "string" | |
| }, | |
| "ip_port_id" : { | |
| "description" : "Unique identifier of the port that uses this IP address to provide access to storage network services, such as iSCSI. This attribute can be set only for an IP address used by networks of type Storage.", | |
| "type" : "string" | |
| }, | |
| "appliance_id" : { | |
| "description" : "Unique identifier of the appliance to which the IP address belongs.", | |
| "type" : "string" | |
| }, | |
| "node_id" : { | |
| "description" : "Unique identifier of the cluster node to which the IP address belongs.", | |
| "type" : "string" | |
| }, | |
| "address" : { | |
| "description" : "IP address value, in IPv4 or IPv6 format.", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "purposes" : { | |
| "description" : "IP address purposes.", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/IpPurposeTypeEnum" | |
| } | |
| }, | |
| "purposes_l10n" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "Localized message array corresponding to purposes" | |
| }, | |
| "network" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/network_instance", | |
| "description" : "This is the embeddable reference form of network_id attribute.", | |
| "x-ref" : "network" | |
| }, | |
| "ip_port" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/ip_port_instance", | |
| "description" : "This is the embeddable reference form of ip_port_id attribute.", | |
| "x-ref" : "ip_port" | |
| }, | |
| "appliance" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/appliance_instance", | |
| "description" : "This is the embeddable reference form of appliance_id attribute.", | |
| "x-ref" : "appliance" | |
| }, | |
| "node" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/node_instance", | |
| "description" : "This is the embeddable reference form of node_id attribute.", | |
| "x-ref" : "node" | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from network, ip_port, appliance, node" | |
| }, | |
| "dns_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "addresses" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the DNS setting.", | |
| "type" : "string" | |
| }, | |
| "addresses" : { | |
| "description" : "DNS server addresses in IPv4 or IPv6 format.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "format" : "ip-address" | |
| } | |
| } | |
| } | |
| }, | |
| "dns_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "addresses" : { | |
| "description" : "DNS server addresses in IPv4 or IPv6 format.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "minItems" : 1, | |
| "maxItems" : 3 | |
| } | |
| }, | |
| "required" : [ "addresses" ] | |
| }, | |
| "ntp_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "addresses" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the NTP setting.", | |
| "type" : "string" | |
| }, | |
| "addresses" : { | |
| "description" : "NTP server addresses. This list may contain IPv4 addresses, IPv6 addresses, and host names.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ntp_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "addresses" : { | |
| "description" : "NTP server addresses. This list may contain IPv4 addresses, IPv6 addresses, and host names.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "minItems" : 1, | |
| "maxItems" : 3 | |
| } | |
| }, | |
| "required" : [ "addresses" ] | |
| }, | |
| "ip_port_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "current_usages", "ip_pool_addresses.address", "ip_pool_addresses.purposes", "bond.name", "eth_port.name", "eth_port.appliance_id", "veth_port.appliance_id", "veth_port.name" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the IP port.", | |
| "type" : "string" | |
| }, | |
| "partner_id" : { | |
| "description" : "Identifier of the IP port that is configured on top of physical Ethernet port or virtual Ethernet port or bond with the same physical location on the other node of the appliance. Partner ports are configured symmetrically for HA and load balancing purposes within the appliance.", | |
| "type" : "string" | |
| }, | |
| "target_iqn" : { | |
| "description" : "iSCSI qualified name used by the target configured on top of the IP port initially or as a result of network scaling. If the IP port is not used by an iSCSI connection, this attribute should be empty.", | |
| "type" : "string" | |
| }, | |
| "available_usages" : { | |
| "description" : "Available IP port usages.", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/IpPortUsageEnum" | |
| } | |
| }, | |
| "current_usages" : { | |
| "description" : "Current IP port usages.", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/IpPortUsageEnum" | |
| } | |
| }, | |
| "bond_id" : { | |
| "description" : "Unique identifier of the bond on top of which the IP port is configured.\nIf the IP port is configured on top of an Ethernet front-end port, this attribute should be empty.\n", | |
| "type" : "string" | |
| }, | |
| "eth_port_id" : { | |
| "description" : "Unique identifier of the physical Ethernet front-end port on top of which the IP port is configured.\nThis attribute can be set when the IP port is used by a Unified appliance. It should be empty if the IP port is used by a Unified+ appliance or if the IP port is configured on top of a bond on a Unified appliance.\n", | |
| "type" : "string" | |
| }, | |
| "veth_port_id" : { | |
| "description" : "Unique identifier of the virtual Ethernet front-end port on top of which the IP port is configured.\nThis attribute can be set when the IP port is used by a Unified+ appliance.\nFor a Unified appliance, the value of veth_port_id should be empty.\n", | |
| "type" : "string" | |
| }, | |
| "available_usages_l10n" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "Localized message array corresponding to available_usages" | |
| }, | |
| "current_usages_l10n" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "Localized message array corresponding to current_usages" | |
| }, | |
| "ip_pool_addresses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ip_pool_address_instance", | |
| "x-ref" : "ip_pool_address_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type ip_pool_address association." | |
| }, | |
| "partner" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/ip_port_instance", | |
| "description" : "This is the embeddable reference form of partner_id attribute.", | |
| "x-ref" : "ip_port" | |
| }, | |
| "bond" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/bond_instance", | |
| "description" : "This is the embeddable reference form of bond_id attribute.", | |
| "x-ref" : "bond" | |
| }, | |
| "eth_port" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/eth_port_instance", | |
| "description" : "This is the embeddable reference form of eth_port_id attribute.", | |
| "x-ref" : "eth_port" | |
| }, | |
| "veth_port" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/veth_port_instance", | |
| "description" : "This is the embeddable reference form of veth_port_id attribute.", | |
| "x-ref" : "veth_port" | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from ip_pool_address, ip_port, bond, eth_port, veth_port" | |
| }, | |
| "ip_port_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "add_current_usages" : { | |
| "description" : "Usages to add to the current usages of an IP port. The current usages of an IP port can be extended with external replication if this usage is in the port's list of available usages. The same settings will be applied to the partner IP port.\n\nWARNING: Only one IP port on each node can be assigned to the External_Replication usage. Assigning another IP port to this usage will automatically unassign the currently used IP port on the same node.\nTo unassign an IP port from being used for external replication, choose another IP port and add External_Replication to its list of current usages.\n", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/IpPortUsageEnum" | |
| }, | |
| "minItems" : 1 | |
| } | |
| } | |
| }, | |
| "physical_switch_connection_instance" : { | |
| "type" : "object", | |
| "properties" : { | |
| "address" : { | |
| "description" : "Physical switch address in IPv4 or IPv6 or DNS hostname format.", | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "minLength" : 1, | |
| "maxLength" : 255 | |
| }, | |
| "port" : { | |
| "description" : "Port used for connection to switch.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 65535 | |
| }, | |
| "connect_method" : { | |
| "$ref" : "#/definitions/PhysicalSwitchConnectMethodEnum" | |
| }, | |
| "username" : { | |
| "description" : "Username to connect a physical switch for SSH connection method.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "physical_switch_id" : { | |
| "description" : "Id of physical switch to which connection belongs.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "connect_method_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to connect_method" | |
| }, | |
| "physical_switch" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/physical_switch_instance", | |
| "description" : "This is the embeddable reference form of physical_switch_id attribute.", | |
| "x-ref" : "physical_switch" | |
| } | |
| }, | |
| "description" : "This resource type has queriable association from physical_switch" | |
| }, | |
| "physical_switch_connection_create" : { | |
| "type" : "object", | |
| "required" : [ "address", "connect_method" ], | |
| "properties" : { | |
| "address" : { | |
| "description" : "Physical switch address in IPv4 or IPv6 or DNS hostname format.", | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "minLength" : 1, | |
| "maxLength" : 255 | |
| }, | |
| "port" : { | |
| "description" : "Port used for connection to switch.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 65535 | |
| }, | |
| "connect_method" : { | |
| "$ref" : "#/definitions/PhysicalSwitchConnectMethodEnum" | |
| }, | |
| "username" : { | |
| "description" : "Username to connect a physical switch for SSH connection method.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "ssh_password" : { | |
| "description" : "SSH password to connect a physical switch if SSH connect method is specified.", | |
| "type" : "string", | |
| "format" : "password", | |
| "maxLength" : 128 | |
| }, | |
| "snmp_community_string" : { | |
| "description" : "SNMPv2 community string, if SNMPv2c connect method is specified.", | |
| "type" : "string", | |
| "format" : "password", | |
| "maxLength" : 128 | |
| } | |
| } | |
| }, | |
| "physical_switch_connection_modify" : { | |
| "type" : "object", | |
| "required" : [ "address", "connect_method" ], | |
| "properties" : { | |
| "address" : { | |
| "description" : "Physical switch address in IPv4 or IPv6 or DNS hostname format.", | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "minLength" : 1, | |
| "maxLength" : 255 | |
| }, | |
| "port" : { | |
| "description" : "Port used for connection to switch.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 65535 | |
| }, | |
| "connect_method" : { | |
| "$ref" : "#/definitions/PhysicalSwitchConnectMethodEnum" | |
| }, | |
| "username" : { | |
| "description" : "Username to connect a physical switch for SSH connection method.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "ssh_password" : { | |
| "description" : "SSH password to connect a physical switch if SSH connect method is specified.", | |
| "type" : "string", | |
| "format" : "password", | |
| "maxLength" : 128 | |
| }, | |
| "snmp_community_string" : { | |
| "description" : "SNMPv2 community string, if SNMPv2c connect method is specified.", | |
| "type" : "string", | |
| "format" : "password", | |
| "maxLength" : 128 | |
| } | |
| } | |
| }, | |
| "physical_switch_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "purpose" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the physical switch setting.", | |
| "type" : "string", | |
| "minLength" : 1, | |
| "maxLength" : 32 | |
| }, | |
| "name" : { | |
| "description" : "Name of physical switch. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "minLength" : 1, | |
| "maxLength" : 128, | |
| "x-case-insensitive" : true | |
| }, | |
| "purpose" : { | |
| "$ref" : "#/definitions/PhysicalSwitchPurposeEnum" | |
| }, | |
| "purpose_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to purpose" | |
| }, | |
| "connections" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/physical_switch_connection_instance", | |
| "x-ref" : "physical_switch_connection_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type physical_switch_connection association." | |
| } | |
| }, | |
| "description" : "This resource type has queriable association from physical_switch_connection" | |
| }, | |
| "physical_switch_create" : { | |
| "type" : "object", | |
| "properties" : { | |
| "name" : { | |
| "description" : "Name of a physical switch.", | |
| "type" : "string", | |
| "minLength" : 1, | |
| "maxLength" : 128 | |
| }, | |
| "purpose" : { | |
| "$ref" : "#/definitions/PhysicalSwitchPurposeEnum" | |
| }, | |
| "connections" : { | |
| "description" : "Supported connections for a physical switch.", | |
| "type" : "array", | |
| "minItems" : 1, | |
| "items" : { | |
| "$ref" : "#/definitions/physical_switch_connection_create" | |
| } | |
| } | |
| }, | |
| "required" : [ "name", "purpose", "connections" ] | |
| }, | |
| "physical_switch_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "name" : { | |
| "description" : "Name of physical switch.", | |
| "type" : "string", | |
| "minLength" : 1, | |
| "maxLength" : 128 | |
| }, | |
| "purpose" : { | |
| "$ref" : "#/definitions/PhysicalSwitchPurposeEnum" | |
| }, | |
| "connections" : { | |
| "description" : "Supported connections for a physical switch.", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/physical_switch_connection_modify" | |
| } | |
| } | |
| } | |
| }, | |
| "PhysicalSwitchConnectMethodEnum" : { | |
| "type" : "string", | |
| "description" : "Physical switch connect method type. Valid values are:\n * SSH - Secure shell.\n * SNMPv2c - SNMPv2 community string.\n", | |
| "enum" : [ "SSH", "SNMPv2c" ], | |
| "x-display_enum_text" : { | |
| "SSH" : "SSH", | |
| "SNMPv2c" : "SNMP v2 community string" | |
| } | |
| }, | |
| "PhysicalSwitchPurposeEnum" : { | |
| "type" : "string", | |
| "description" : "Physical switch purpose in network. Possible purposes are:\n * Data_and_Management - Physical switch for all data and management networks.\n * Management_Only - Physical switch for management network only.\n", | |
| "enum" : [ "Data_and_Management", "Management_Only" ], | |
| "x-display_enum_text" : { | |
| "Data_and_Management" : "Data and Management", | |
| "Management_Only" : "Management Only" | |
| } | |
| }, | |
| "bond_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "is_link_up", "mtu", "mode", "eth_ports.name", "eth_ports.appliance_id" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the bond.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "Bond name. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "is_link_up" : { | |
| "description" : "Indicates whether the bond's link is up. Values are:\n* true - Link is up.\n* false - Link is down.\n", | |
| "type" : "boolean" | |
| }, | |
| "mtu" : { | |
| "description" : "Maximum Transmission Unit (MTU) packet size that the bond can transmit, in bytes.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "mode" : { | |
| "$ref" : "#/definitions/BondingModeEnum" | |
| }, | |
| "mode_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to mode" | |
| }, | |
| "ip_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ip_port_instance", | |
| "x-ref" : "ip_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type ip_port association." | |
| }, | |
| "eth_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/eth_port_instance", | |
| "x-ref" : "eth_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type eth_port association." | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from ip_port, eth_port" | |
| }, | |
| "veth_port_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "appliance_id", "name", "mac_address", "is_link_up", "current_speed", "current_mtu" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the virtual Ethernet port instance.", | |
| "type" : "string" | |
| }, | |
| "appliance_id" : { | |
| "description" : "Unique identifier of the appliance.", | |
| "type" : "string" | |
| }, | |
| "node_id" : { | |
| "description" : "Unique identifier of the cluster.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "Virtual Ethernet port name. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "mac_address" : { | |
| "description" : "Virtual Ethernet port MAC address.", | |
| "type" : "string" | |
| }, | |
| "is_link_up" : { | |
| "description" : "Indicates whether the virtual Ethernet port's link is up. Values are:\n* true - Link is up.\n* false - Link is down.\n", | |
| "type" : "boolean" | |
| }, | |
| "current_speed" : { | |
| "description" : "Virtual Ethernet port transmission speed, in bits/sec (bps).", | |
| "type" : "integer", | |
| "format" : "int64", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "current_mtu" : { | |
| "description" : "Maximum Transmission Unit (MTU) packet size that the virtual Ethernet port can transmit.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "vswitch_name" : { | |
| "description" : "Name of the virtual switch that holds the virtual Ethernet port.", | |
| "type" : "string" | |
| }, | |
| "vswitch_port_group_name" : { | |
| "description" : "Name of virtual switch port group to which the virtual Ethernet port is assigned.", | |
| "type" : "string" | |
| }, | |
| "vswitch_port_id" : { | |
| "description" : "Unique identifier of the virtual switch port associated with the virtual Ethernet port.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "vswitch_port_name" : { | |
| "description" : "Name of the virtual switch port associated with the virtual Ethernet port. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "ip_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ip_port_instance", | |
| "x-ref" : "ip_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type ip_port association." | |
| }, | |
| "appliance" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/appliance_instance", | |
| "description" : "This is the embeddable reference form of appliance_id attribute.", | |
| "x-ref" : "appliance" | |
| }, | |
| "node" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/node_instance", | |
| "description" : "This is the embeddable reference form of node_id attribute.", | |
| "x-ref" : "node" | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from ip_port, appliance, node" | |
| }, | |
| "AlertStateEnum" : { | |
| "description" : "Alert State Enum with values - Active and Cleared.", | |
| "type" : "string", | |
| "enum" : [ "ACTIVE", "CLEARED" ], | |
| "x-display_enum_text" : { | |
| "ACTIVE" : "Active", | |
| "CLEARED" : "Cleared" | |
| } | |
| }, | |
| "alert_instance" : { | |
| "type" : "object", | |
| "description" : "An alert is a summation of one or more events that need (or needed) attention. Some events require attention and result in an alert being generated. Other events can update or clear an alert when the system detects a change in the condition that needs attention. To deal with an alert, look at the information about the most recent event included in the alert. In particular, examine the resource that the alert was generated about (using resource_type and resource_id or resource_name) as well as the system_impact_l10n and suggested repair_flow_l10n parameters.", | |
| "x-select_cli" : [ "id", "event_code", "severity", "resource_name", "description_l10n", "generated_timestamp", "state", "is_acknowledged" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the alert.", | |
| "type" : "string" | |
| }, | |
| "event_code" : { | |
| "description" : "The event code of the latest event for this alert.", | |
| "type" : "string" | |
| }, | |
| "severity" : { | |
| "description" : "Severity of the latest event for this alert.", | |
| "$ref" : "#/definitions/SeverityEnum" | |
| }, | |
| "resource_type" : { | |
| "description" : "Type of the resource instance which generated this alert.", | |
| "$ref" : "#/definitions/ResourceTypeEnum" | |
| }, | |
| "resource_id" : { | |
| "description" : "Unique identifier of the resource instance which generated this alert.", | |
| "type" : "string" | |
| }, | |
| "resource_name" : { | |
| "description" : "Name of the resource instance which generated this alert. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "description_l10n" : { | |
| "description" : "Latest event's description text for this alert.", | |
| "type" : "string" | |
| }, | |
| "generated_timestamp" : { | |
| "description" : "Timestamp of the latest event for this alert.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "state" : { | |
| "$ref" : "#/definitions/AlertStateEnum" | |
| }, | |
| "is_acknowledged" : { | |
| "description" : "Whether an alert has been acknowledged.", | |
| "type" : "boolean" | |
| }, | |
| "raised_timestamp" : { | |
| "description" : "Timestamp of the first event for this alert.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "cleared_timestamp" : { | |
| "description" : "Timestamp of the event that cleared this alert.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "called_home_timestamp" : { | |
| "description" : "Timestamp when the event resulted in a notification to support (via Secured Remote Services), if any.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "email_sent_timestamp" : { | |
| "description" : "Timestamp when the email was sent for the raised alert, if any.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "acknowledged_timestamp" : { | |
| "description" : "Timestamp when the alert was acknowledged, if any.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "events" : { | |
| "description" : "List of events associated with this alert. \nFiltering on the fields of this embedded resource is not supported.", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/event_instance" | |
| }, | |
| "x-no_filter" : true | |
| }, | |
| "severity_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to severity" | |
| }, | |
| "resource_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to resource_type" | |
| }, | |
| "state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to state" | |
| } | |
| } | |
| }, | |
| "alert_modify" : { | |
| "type" : "object", | |
| "description" : "Alert modify request body.", | |
| "required" : [ "is_acknowledged" ], | |
| "properties" : { | |
| "is_acknowledged" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the alert has been acknowledged." | |
| }, | |
| "acknowledged_severity" : { | |
| "$ref" : "#/definitions/SeverityEnum" | |
| } | |
| } | |
| }, | |
| "metrics_generate" : { | |
| "type" : "object", | |
| "description" : "Metrics for specified entity", | |
| "required" : [ "entity", "entity_id" ], | |
| "properties" : { | |
| "entity" : { | |
| "$ref" : "#/definitions/MetricsEntityEnum" | |
| }, | |
| "entity_id" : { | |
| "type" : "string", | |
| "description" : "Identifier for specific entity." | |
| }, | |
| "interval" : { | |
| "$ref" : "#/definitions/MetricsIntervalEnum" | |
| } | |
| } | |
| }, | |
| "metrics_generate_response" : { | |
| "type" : "object", | |
| "description" : "Response will be just an array of one of the child of this definition", | |
| "discriminator" : "entity", | |
| "required" : [ "entity" ], | |
| "properties" : { | |
| "entity" : { | |
| "$ref" : "#/definitions/MetricsEntityEnum" | |
| }, | |
| "entity_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to entity" | |
| } | |
| } | |
| }, | |
| "MetricsEntityEnum" : { | |
| "type" : "string", | |
| "description" : "An enum describing the various entities supported by metrics.\n * performance_metrics_by_appliance - Appliance performance metrics.\n * performance_metrics_by_node - Node performance metrics.\n * performance_metrics_by_volume - Volume performance metrics.\n * performance_metrics_by_cluster - Cluster performance metrics.\n * performance_metrics_by_vm - Virtual Machine performance metrics.\n * performance_metrics_by_vg - Storage performance metrics for all volumes in a volume group\n * performance_metrics_by_fe_fc_port - Frontend fibre channel port performance metrics.\n * performance_metrics_by_fe_eth_port - Frontend ethernet port performance metrics.\n * performance_metrics_by_fe_eth_node - Frontend ethernet performance metrics for node.\n * performance_metrics_by_fe_fc_node - Frontend fibre channel performance metrics for node.\n * wear_metrics_by_drive - Drive wear metrics.\n * space_metrics_by_cluster - Cluster space metrics\n * space_metrics_by_appliance - Appliance space metrics\n * space_metrics_by_volume - Volume space metrics\n * space_metrics_by_volume_family - Volume family space metrics\n * space_metrics_by_vm - Virtual Machine space metrics\n * space_metrics_by_storage_container - Storage Container space metrics\n * space_metrics_by_vg - Volume space metrics in a volume group\n * copy_metrics_by_appliance - Appliance copy metrics\n * copy_metrics_by_cluster - Cluster copy metrics\n * copy_metrics_by_vg - Copy metrics for each volume group\n * copy_metrics_by_remote_system - Copy metrics for each remote system\n * copy_metrics_by_volume - Copy metrics for each volume\n * performance_metrics_by_file_system - Performance metrics for the file system.\n * performance_metrics_smb_by_node - Performance metrics for the SMB protocol global\n * performance_metrics_smb_builtinclient_by_node - Performance metrics for the SMB protocol built-in client\n * performance_metrics_smb_branch_cache_by_node - Performance metrics for the SMB protocol Branch-Cache\n * performance_metrics_smb1_by_node - Performance metrics for the SMB1 protocol basic\n * performance_metrics_smb1_builtinclient_by_node - Performance metrics for the SMB1 protocol built-in client\n * performance_metrics_smb2_by_node - Performance metrics for the SMB2 protocol basic\n * performance_metrics_smb2_builtinclient_by_node - Performance metrics for the SMB2 protocol built-in client\n * performance_metrics_nfs_by_node - Performance metrics for the NFS protocol\n * performance_metrics_nfsv3_by_node - Performance metrics for the NFSv3 protocol\n * performance_metrics_nfsv4_by_node - Performance metrics for the NFSv4 protocol\n", | |
| "enum" : [ "performance_metrics_by_appliance", "performance_metrics_by_node", "performance_metrics_by_volume", "performance_metrics_by_cluster", "performance_metrics_by_vm", "performance_metrics_by_vg", "performance_metrics_by_fe_fc_port", "performance_metrics_by_fe_eth_port", "performance_metrics_by_fe_eth_node", "performance_metrics_by_fe_fc_node", "wear_metrics_by_drive", "space_metrics_by_cluster", "space_metrics_by_appliance", "space_metrics_by_volume", "space_metrics_by_volume_family", "space_metrics_by_vm", "space_metrics_by_storage_container", "space_metrics_by_vg", "copy_metrics_by_appliance", "copy_metrics_by_cluster", "copy_metrics_by_vg", "copy_metrics_by_remote_system", "copy_metrics_by_volume", "performance_metrics_by_file_system", "performance_metrics_smb_by_node", "performance_metrics_smb_builtinclient_by_node", "performance_metrics_smb_branch_cache_by_node", "performance_metrics_smb1_by_node", "performance_metrics_smb1_builtinclient_by_node", "performance_metrics_smb2_by_node", "performance_metrics_smb2_builtinclient_by_node", "performance_metrics_nfs_by_node", "performance_metrics_nfsv3_by_node", "performance_metrics_nfsv4_by_node" ], | |
| "x-display_enum_text" : { | |
| "performance_metrics_by_appliance" : "Appliance performance metrics", | |
| "performance_metrics_by_node" : "Node performance metrics", | |
| "performance_metrics_by_volume" : "Volume performance metrics", | |
| "performance_metrics_by_cluster" : "Cluster performance metrics", | |
| "performance_metrics_by_vm" : "Virtual Machine performance metrics", | |
| "performance_metrics_by_vg" : "Metrics for all volumes in a volume group", | |
| "performance_metrics_by_fe_fc_port" : "Frontend fibre channel port performance metrics", | |
| "performance_metrics_by_fe_eth_port" : "Frontend ethernet port 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", | |
| "space_metrics_by_cluster" : "Cluster space metrics", | |
| "space_metrics_by_appliance" : "Appliance space metrics", | |
| "space_metrics_by_volume" : "Volume space metrics", | |
| "space_metrics_by_volume_family" : "Volume Family space metrics", | |
| "space_metrics_by_vm" : "Virtual Machine space metrics", | |
| "space_metrics_by_storage_container" : "Storage Container space metrics", | |
| "space_metrics_by_vg" : "Volume space metrics in a volume group", | |
| "copy_metrics_by_appliance" : "Appliance copy metrics", | |
| "copy_metrics_by_cluster" : "Cluster copy metrics", | |
| "copy_metrics_by_vg" : "Cluster wide copy metrics for each volume group", | |
| "copy_metrics_by_remote_system" : "Copy metrics for each remote system", | |
| "copy_metrics_by_volume" : "Copy metrics for each volume", | |
| "performance_metrics_by_file_system" : "Performance metrics for the file system", | |
| "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 metrics for the SMB2 protocol basic", | |
| "performance_metrics_smb2_builtinclient_by_node" : "Performance metrics for the SMB2 protocol built-in", | |
| "performance_metrics_nfs_by_node" : "Performance metrics for the NFS protocol", | |
| "performance_metrics_nfsv3_by_node" : "Performance metrics for the NFSv3 protocol", | |
| "performance_metrics_nfsv4_by_node" : "Performance metrics for the NFSv4 protocol" | |
| } | |
| }, | |
| "MetricsIntervalEnum" : { | |
| "description" : "Intervals of which metrics can be provided.", | |
| "type" : "string", | |
| "enum" : [ "Twenty_Sec", "Five_Mins", "One_Hour", "One_Day" ], | |
| "x-display_enum_text" : { | |
| "Twenty_Sec" : "Twenty Seconds", | |
| "Five_Mins" : "Five Minutes", | |
| "One_Hour" : "One Hour", | |
| "One_Day" : "One Day" | |
| } | |
| }, | |
| "space_metrics_by_cluster" : { | |
| "type" : "object", | |
| "description" : "Space metrics for the cluster collected at five minute interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_cluster" | |
| } ] | |
| }, | |
| "space_metrics_by_cluster_rollup" : { | |
| "type" : "object", | |
| "description" : "Summary of cluster level space metric data for a specific period of time, beginning with timestamp, including the maximum and final values for that period. Current support is for a time period of one hour and one day.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_cluster_rollup" | |
| } ] | |
| }, | |
| "space_metrics_by_appliance" : { | |
| "type" : "object", | |
| "description" : "Space metrics for the appliance collected at five minute interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_appliance" | |
| } ] | |
| }, | |
| "space_metrics_by_appliance_rollup" : { | |
| "type" : "object", | |
| "description" : "Summary of appliance level space metric data for a specific period of time, beginning with timestamp and including the maximum and final values for that period. Current support is for a time period of one hour and one day.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_appliance_rollup" | |
| } ] | |
| }, | |
| "space_metrics_by_volume" : { | |
| "description" : "Space metrics for the volume collected at five minute interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_volume" | |
| } ] | |
| }, | |
| "space_metrics_by_volume_rollup" : { | |
| "description" : "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.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_volume_rollup" | |
| } ] | |
| }, | |
| "space_metrics_by_volume_family" : { | |
| "description" : "Space metrics for the volume family collected at five minute interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_volume_family" | |
| } ] | |
| }, | |
| "space_metrics_by_volume_family_rollup" : { | |
| "description" : "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.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_volume_family_rollup" | |
| } ] | |
| }, | |
| "space_metrics_by_vm" : { | |
| "description" : "Space metrics for the VM collected at five minute interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_vm" | |
| } ] | |
| }, | |
| "space_metrics_by_vm_rollup" : { | |
| "description" : "Summary of VM level space metric data for one hour or one day period beginning with timestamp, including the maximum and final values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_vm_rollup" | |
| } ] | |
| }, | |
| "space_metrics_by_storage_container" : { | |
| "description" : "Space metrics of storage container aggregated from all appliances collected at five minute interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_storage_container" | |
| } ] | |
| }, | |
| "space_metrics_by_storage_container_rollup" : { | |
| "description" : "Summary of storage container level space metric data for a specific period of time beginning with timestamp, including the maximum and final values for that period. Current support is for a time period of one hour and one day.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_storage_container_rollup" | |
| } ] | |
| }, | |
| "space_metrics_by_vg" : { | |
| "description" : "Space metrics for a volume group collected at a five minute interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_vg" | |
| } ] | |
| }, | |
| "space_metrics_by_vg_rollup" : { | |
| "description" : "Summary of volume group level space metric data for one hour or one day period beginning with timestamp, including the maximum and final values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_space_metrics_by_vg_rollup" | |
| } ] | |
| }, | |
| "storage_container_instance" : { | |
| "type" : "object", | |
| "description" : "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.\r\nThis resource type has queriable association from virtual_volume", | |
| "x-select_cli" : [ "id", "name", "quota" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "The unique id of the storage container." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name for the storage container. This should be unique across all storage containers in the cluster. Name can be from 1 to 64 UTF-8 characters, and not more than 127 bytes. \nThis property supports case-insensitive filtering", | |
| "minLength" : 1, | |
| "maxLength" : 64, | |
| "x-case-insensitive" : true | |
| }, | |
| "quota" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "description" : "The total number of bytes that can be provisioned/reserved against this storage container. A value of 0 means there is no limit. It is possible to set the quota to a value that overprovisions the amount of space available in the system.", | |
| "x-units" : "bytes", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "virtual_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/virtual_volume_instance", | |
| "x-ref" : "virtual_volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type virtual_volume association." | |
| } | |
| } | |
| }, | |
| "storage_container_create" : { | |
| "type" : "object", | |
| "description" : "Parameters for storage container create.", | |
| "required" : [ "name" ], | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name for the storage container that is unique across all storage containers in the cluster. The name must be between 1 and 64 UTF-8 characters (inclusive), and not more than 127 bytes.", | |
| "minLength" : 1, | |
| "maxLength" : 64 | |
| }, | |
| "quota" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "maximum" : 4611686018427387904, | |
| "description" : "The number of bytes that can be provisioned against this storage container. This must be a value greater than 10Gb and the default is 0 which means no limit.", | |
| "x-units" : "bytes", | |
| "default" : 0, | |
| "minimum" : 0 | |
| } | |
| } | |
| }, | |
| "storage_container_delete" : { | |
| "type" : "object", | |
| "description" : "Parameters for storage container delete.", | |
| "properties" : { | |
| "force" : { | |
| "type" : "boolean", | |
| "description" : "Normally, deletion of a storage container that is mounted or still contains virtual volumes will be rejected. This option overrides that error and allows the delete to continue. Use with great caution." | |
| } | |
| } | |
| }, | |
| "storage_container_modify" : { | |
| "type" : "object", | |
| "description" : "Parameters for storage container modify.", | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "New name for the storage container that is unique across all storage containers in the cluster. The name must be between 1 and 64 UTF-8 characters (inclusive), and not more than 127 bytes.", | |
| "minLength" : 1, | |
| "maxLength" : 64 | |
| }, | |
| "quota" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "maximum" : 4611686018427387904, | |
| "description" : "The number of bytes that can be provisioned against this storage container. It cannot be set lower than the current used space or 10Gb. A value of 0 means unlimited.", | |
| "x-units" : "bytes", | |
| "minimum" : 0 | |
| } | |
| } | |
| }, | |
| "storage_container_mount" : { | |
| "type" : "object", | |
| "description" : "Properties for mounting storage container.", | |
| "properties" : { | |
| "datastore_name" : { | |
| "type" : "string", | |
| "description" : "This will be the vVol datastore name in vCenter when it is mounted." | |
| } | |
| } | |
| }, | |
| "virtual_volume_delete" : { | |
| "type" : "object", | |
| "description" : "Parameters for virtual volume delete.", | |
| "properties" : { | |
| "force" : { | |
| "type" : "boolean", | |
| "description" : "Normally, attempting to delete a bound virtual volume is not permitted. This option overrides that error and allows the delete to continue." | |
| } | |
| } | |
| }, | |
| "performance_metrics_by_appliance" : { | |
| "type" : "object", | |
| "description" : "Performance metrics for the appliance collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_appliance" | |
| } ] | |
| }, | |
| "performance_metrics_by_appliance_rollup" : { | |
| "type" : "object", | |
| "description" : "Summary of appliance level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_appliance_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_node" : { | |
| "type" : "object", | |
| "description" : "Performance metrics for the node collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_node" | |
| } ] | |
| }, | |
| "performance_metrics_by_node_rollup" : { | |
| "type" : "object", | |
| "description" : "Summary of node level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_node_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_volume" : { | |
| "type" : "object", | |
| "description" : "Performance metrics for the volume collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_volume" | |
| } ] | |
| }, | |
| "performance_metrics_by_volume_rollup" : { | |
| "type" : "object", | |
| "description" : "Summary of volume level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_volume_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_cluster" : { | |
| "type" : "object", | |
| "description" : "Performance metrics for the cluster collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_cluster" | |
| } ] | |
| }, | |
| "performance_metrics_by_cluster_rollup" : { | |
| "type" : "object", | |
| "description" : "Summary of cluster level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_cluster_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_vm" : { | |
| "type" : "object", | |
| "description" : "Performance metrics for the virtual machine collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_vm" | |
| } ] | |
| }, | |
| "performance_metrics_by_vm_rollup" : { | |
| "description" : "Summary of virtual machine level performance metric data for various rollup intervals beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_vm_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_vg" : { | |
| "type" : "object", | |
| "description" : "Performance metrics for the volumes in a volume group collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_vg" | |
| } ] | |
| }, | |
| "performance_metrics_by_fe_fc_port" : { | |
| "type" : "object", | |
| "description" : "Performance metrics for the frontend fibre channel port collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_fe_fc_port" | |
| } ] | |
| }, | |
| "performance_metrics_by_fe_fc_port_rollup" : { | |
| "type" : "object", | |
| "description" : "Performance metrics for the frontend fibre channel port rolled up at various intervals.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_fe_fc_port_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_fe_eth_port" : { | |
| "type" : "object", | |
| "description" : "Performance metrics for the frontend ethernet port collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_fe_eth_port" | |
| } ] | |
| }, | |
| "performance_metrics_by_fe_eth_port_rollup" : { | |
| "type" : "object", | |
| "description" : "Performance metrics for the frontend ethernet port rolled up at various rollup intervals.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_fe_eth_port_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_fe_eth_node" : { | |
| "type" : "object", | |
| "description" : "Ethernet performance metrics for the node collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_fe_eth_node" | |
| } ] | |
| }, | |
| "performance_metrics_by_fe_eth_node_rollup" : { | |
| "type" : "object", | |
| "description" : "Ethernet performance metrics for the node rolled up at various rollup intervals.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_fe_eth_node_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_fe_fc_node" : { | |
| "type" : "object", | |
| "description" : "Fibre channel performance metrics for the node collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_fe_fc_node" | |
| } ] | |
| }, | |
| "performance_metrics_by_fe_fc_node_rollup" : { | |
| "type" : "object", | |
| "description" : "Fibre channel performance metrics for the node rolled up at various rollup intervals.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_fe_fc_node_rollup" | |
| } ] | |
| }, | |
| "wear_metrics_by_drive_instance" : { | |
| "description" : "Wear metrics for the drives collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_wear_metrics_by_drive_instance" | |
| } ] | |
| }, | |
| "SeverityEnum" : { | |
| "title" : "SeverityEnum", | |
| "description" : "Possible severities.", | |
| "type" : "string", | |
| "enum" : [ "None", "Info", "Minor", "Major", "Critical" ], | |
| "x-display_enum_text" : { | |
| "None" : "None", | |
| "Info" : "Info", | |
| "Minor" : "Minor", | |
| "Major" : "Major", | |
| "Critical" : "Critical" | |
| } | |
| }, | |
| "ResourceTypeEnum" : { | |
| "type" : "string", | |
| "description" : "Resource Type for the given resource.", | |
| "enum" : [ "alert", "appliance", "audit_event", "bond", "chap_config", "cluster", "discovered_initiator", "dns", "email_notify_destination", "eth_port", "event", "fc_port", "file_dns", "file_ftp", "file_interface", "file_interface_route", "file_kerberos", "file_ldap", "file_ndmp", "file_nis", "file_system", "file_tree_quota", "file_user_quota", "file_virus_checker", "hardware", "host", "host_group", "host_virtual_volume_mapping", "host_volume_mapping", "import_host_initiator", "import_host_system", "import_host_volume", "import_psgroup", "import_psgroup_volume", "import_session", "import_storage_center", "import_storage_center_consistency_group", "import_storage_center_volume", "import_unity", "import_unity_consistency_group", "import_unity_volume", "import_vnx_array", "import_vnx_consistency_group", "import_vnx_volume", "ip_pool_address", "ip_port", "job", "keystore_archive", "license", "local_user", "login_session", "maintenance_window", "metrics", "migration_recommendation", "migration_session", "nas_server", "ndu", "network", "nfs_export", "nfs_server", "node", "ntp", "performance_rule", "physical_switch", "policy", "remote_system", "replication_rule", "replication_session", "role", "sas_port", "scheduler", "security_config", "service_config", "service_user", "smb_server", "smb_share", "smtp_config", "snapshot_rule", "software_installed", "software_package", "storage_container", "vcenter", "veth_port", "virtual_machine", "virtual_volume", "volume", "volume_group", "x509_certificate" ], | |
| "x-display_enum_text" : { | |
| "alert" : "alert", | |
| "appliance" : "appliance", | |
| "audit_event" : "audit event", | |
| "bond" : "bond", | |
| "chap_config" : "chap config:wq", | |
| "cluster" : "cluster", | |
| "discovered_initiator" : "discovered initiator", | |
| "dns" : "dns", | |
| "email_notify_destination" : "email notify destination", | |
| "eth_port" : "eth port", | |
| "event" : "event", | |
| "fc_port" : "fc port", | |
| "file_dns" : "file dns", | |
| "file_ftp" : "file ftp", | |
| "file_interface" : "file interface", | |
| "file_interface_route" : "file interface route", | |
| "file_kerberos" : "file kerberos", | |
| "file_ldap" : "file ldap", | |
| "file_ndmp" : "file ndmp", | |
| "file_nis" : "file nis", | |
| "file_system" : "file system", | |
| "file_tree_quota" : "file tree quota", | |
| "file_user_quota" : "file user quota", | |
| "file_virus_checker" : "file virus checker", | |
| "hardware" : "hardware", | |
| "host" : "host", | |
| "host_group" : "host group", | |
| "host_virtual_volume_mapping" : "host virtual volume mapping", | |
| "host_volume_mapping" : "host volume mapping", | |
| "import_host_initiator" : "import host initiator", | |
| "import_host_system" : "import host system", | |
| "import_host_volume" : "import host volume", | |
| "import_psgroup" : "import psgroup", | |
| "import_psgroup_volume" : "import psgroup volume", | |
| "import_session" : "import session", | |
| "import_storage_center" : "import storage center", | |
| "import_storage_center_consistency_group" : "import storage center consistency group", | |
| "import_storage_center_volume" : "import storage center volume", | |
| "import_unity" : "import unity", | |
| "import_unity_consistency_group" : "import unity consistency group", | |
| "import_unity_volume" : "import unity volume", | |
| "import_vnx_array" : "import vnx array", | |
| "import_vnx_consistency_group" : "import vnx consistency group", | |
| "import_vnx_volume" : "import vnx volume", | |
| "ip_pool_address" : "ip pool address", | |
| "ip_port" : "ip port", | |
| "job" : "job", | |
| "keystore_archive" : "keystore archive", | |
| "license" : "license", | |
| "local_user" : "local user", | |
| "login_session" : "login session", | |
| "maintenance_window" : "maintenance window", | |
| "metrics" : "metrics", | |
| "migration_recommendation" : "migration recommendation", | |
| "migration_session" : "migration session", | |
| "nas_server" : "nas server", | |
| "ndu" : "non-disruptive upgrade", | |
| "network" : "network", | |
| "nfs_export" : "nfs export", | |
| "nfs_server" : "nfs server", | |
| "node" : "node", | |
| "ntp" : "ntp", | |
| "performance_rule" : "performance rule", | |
| "physical_switch" : "physical switch", | |
| "policy" : "policy", | |
| "remote_system" : "remote system", | |
| "replication_rule" : "replication rule", | |
| "replication_session" : "replication session", | |
| "role" : "role", | |
| "sas_port" : "sas port", | |
| "scheduler" : "scheduler", | |
| "security_config" : "security config", | |
| "service_config" : "service config", | |
| "service_user" : "service user", | |
| "smb_server" : "smb server", | |
| "smb_share" : "smb share", | |
| "smtp_config" : "smtp config", | |
| "snapshot_rule" : "snapshot rule", | |
| "software_installed" : "software installed", | |
| "software_package" : "software package", | |
| "storage_container" : "storage container", | |
| "vcenter" : "vcenter", | |
| "veth_port" : "veth port", | |
| "virtual_machine" : "virtual machine", | |
| "virtual_volume" : "virtual volume", | |
| "volume" : "volume", | |
| "volume_group" : "volume group", | |
| "x509_certificate" : "x509 certificate" | |
| } | |
| }, | |
| "IoPriorityEnum" : { | |
| "type" : "string", | |
| "title" : "IoPriorityEnum", | |
| "description" : "The I/O priority for quality of service rules.", | |
| "enum" : [ "Low", "Medium", "High" ], | |
| "x-display_enum_text" : { | |
| "Low" : "Low", | |
| "Medium" : "Medium", | |
| "High" : "High" | |
| } | |
| }, | |
| "smtp_config_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "address", "port", "source_email" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the SMTP configuration. This value is always '0'.", | |
| "type" : "string" | |
| }, | |
| "address" : { | |
| "description" : "IP address of the SMTP server.", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "port" : { | |
| "description" : "Port used for sending SMTP messages.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "maximum" : 65535, | |
| "minimum" : 0 | |
| }, | |
| "source_email" : { | |
| "description" : "Source email address used for sending SMTP messages.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "smtp_config_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "address" : { | |
| "description" : "IP address of the SMTP server.", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "port" : { | |
| "description" : "Port used for sending SMTP messages.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 65535 | |
| }, | |
| "source_email" : { | |
| "description" : "Source email address used for sending SMTP messages.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "smtp_config_test" : { | |
| "type" : "object", | |
| "properties" : { | |
| "email_address" : { | |
| "description" : "Destination email address for the test.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "email_notify_destination_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "email_address", "notify_critical", "notify_major", "notify_minor", "notify_info" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the email notification destination.", | |
| "type" : "string" | |
| }, | |
| "email_address" : { | |
| "description" : "Email address to receive notifications.", | |
| "type" : "string" | |
| }, | |
| "notify_critical" : { | |
| "description" : "Whether to send notifications for critical alerts.", | |
| "type" : "boolean" | |
| }, | |
| "notify_major" : { | |
| "description" : "Whether to send notifications for major alerts.", | |
| "type" : "boolean" | |
| }, | |
| "notify_minor" : { | |
| "description" : "Whether to send notifications for minor alerts.", | |
| "type" : "boolean" | |
| }, | |
| "notify_info" : { | |
| "description" : "Whether to send notifications for informational alerts.", | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "email_notify_destination_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "email_address" : { | |
| "description" : "Email address to receive notifications.", | |
| "type" : "string" | |
| }, | |
| "notify_critical" : { | |
| "description" : "Whether to send notifications for critical alerts.", | |
| "type" : "boolean" | |
| }, | |
| "notify_major" : { | |
| "description" : "Whether to send notifications for major alerts.", | |
| "type" : "boolean" | |
| }, | |
| "notify_minor" : { | |
| "description" : "Whether to send notifications for minor alerts.", | |
| "type" : "boolean" | |
| }, | |
| "notify_info" : { | |
| "description" : "Whether to send notifications for informational alerts.", | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "email_notify_destination_create" : { | |
| "type" : "object", | |
| "required" : [ "email_address" ], | |
| "properties" : { | |
| "email_address" : { | |
| "description" : "Email address to receive notifications.", | |
| "type" : "string" | |
| }, | |
| "notify_critical" : { | |
| "description" : "Whether to send notifications for critical alerts.", | |
| "type" : "boolean" | |
| }, | |
| "notify_major" : { | |
| "description" : "Whether to send notifications for major alerts.", | |
| "type" : "boolean" | |
| }, | |
| "notify_minor" : { | |
| "description" : "Whether to send notifications for minor alerts.", | |
| "type" : "boolean" | |
| }, | |
| "notify_info" : { | |
| "description" : "Whether send notifications for informational alerts.", | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "performance_rule_instance" : { | |
| "type" : "object", | |
| "description" : "Quality of service rule in a performance policy for policy based management of storage resources.\r\nThis resource type has queriable association from policy", | |
| "x-select_cli" : [ "id", "name" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier representing a performance rule." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the performance rule. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "io_priority" : { | |
| "$ref" : "#/definitions/IoPriorityEnum" | |
| }, | |
| "io_priority_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to io_priority" | |
| }, | |
| "policies" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/policy_instance", | |
| "x-ref" : "policy" | |
| }, | |
| "description" : "List of the policies that are associated with this performance_rule." | |
| } | |
| } | |
| }, | |
| "maintenance_window_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "appliance_id", "is_enabled", "end_time" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the maintenance window.", | |
| "type" : "string" | |
| }, | |
| "appliance_id" : { | |
| "description" : "Appliance id on which this maintenance window is configured.", | |
| "type" : "string" | |
| }, | |
| "is_enabled" : { | |
| "description" : "Whether the maintenance window is active.", | |
| "type" : "boolean" | |
| }, | |
| "end_time" : { | |
| "description" : "Time when the maintenance window will close (or did close).", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "appliance" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/appliance_instance", | |
| "description" : "This is the embeddable reference form of appliance_id attribute.", | |
| "x-ref" : "appliance" | |
| } | |
| }, | |
| "description" : "This resource type has queriable association from appliance" | |
| }, | |
| "maintenance_window_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "is_enabled" : { | |
| "description" : "Activate or deactivate the window for one appliance.", | |
| "type" : "boolean" | |
| }, | |
| "end_offset" : { | |
| "description" : "Number of seconds from the current timestamp the maintenance window will expire. This value is required if is_enabled is passed as true, and may not be more than 172800 (48 hours).", | |
| "type" : "integer", | |
| "maximum" : 172800, | |
| "format" : "int32", | |
| "minimum" : 0 | |
| } | |
| } | |
| }, | |
| "ForecastMetricTypeEnum" : { | |
| "description" : "Metric type to be forecast.", | |
| "type" : "string", | |
| "enum" : [ "Physical_Space_Used_One_Day" ], | |
| "x-display_enum_text" : { | |
| "Physical_Space_Used_One_Day" : "Average Daily Physical Space Used" | |
| } | |
| }, | |
| "ForecastTimeToFullStatusEnum" : { | |
| "description" : "Type of alert indicated for object based on projected time to full. \n * `OK` - Time to full value is greater than 28 days. No alert indicated.\n * `Minor` - Time to full value is less than or equal to 28 days but greater than 14 days. Minor alert indicated.\n * `Major` - Time to full value is less than or equal to 14 days. Major alert indicated.\n * `None` - There is insufficient forecast data to project time to full to at least 28 days. No alert indicated, but available data cannot guarantee `OK` status.\n", | |
| "type" : "string", | |
| "enum" : [ "OK", "Minor", "Major", "None" ], | |
| "x-display_enum_text" : { | |
| "OK" : "OK", | |
| "Minor" : "Minor", | |
| "Major" : "Major", | |
| "None" : "None" | |
| } | |
| }, | |
| "appliance_forecast" : { | |
| "type" : "object", | |
| "required" : [ "metric_type" ], | |
| "properties" : { | |
| "metric_type" : { | |
| "$ref" : "#/definitions/ForecastMetricTypeEnum" | |
| } | |
| } | |
| }, | |
| "appliance_forecast_response" : { | |
| "type" : "object", | |
| "properties" : { | |
| "timestamp" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Date-time of the forecast data." | |
| }, | |
| "low_value" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "description" : "Estimate for the lower bound forecasted value on that particular time.", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "mean_value" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "description" : "Estimate for the mean forecasted value on that particular time.", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "high_value" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "description" : "Estimate for the upper bound forecasted value on that particular time.", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| } | |
| } | |
| }, | |
| "cluster_forecast" : { | |
| "type" : "object", | |
| "required" : [ "metric_type" ], | |
| "properties" : { | |
| "metric_type" : { | |
| "$ref" : "#/definitions/ForecastMetricTypeEnum" | |
| } | |
| } | |
| }, | |
| "appliance_time_to_full" : { | |
| "type" : "object", | |
| "required" : [ "metric_type" ], | |
| "properties" : { | |
| "metric_type" : { | |
| "$ref" : "#/definitions/ForecastMetricTypeEnum" | |
| } | |
| } | |
| }, | |
| "cluster_time_to_full" : { | |
| "type" : "object", | |
| "required" : [ "metric_type" ], | |
| "properties" : { | |
| "metric_type" : { | |
| "$ref" : "#/definitions/ForecastMetricTypeEnum" | |
| } | |
| } | |
| }, | |
| "cluster_forecast_response" : { | |
| "type" : "object", | |
| "properties" : { | |
| "timestamp" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Timestamp when the forecast was performed." | |
| }, | |
| "low_value" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "description" : "Estimate of the lower bound of the 95% confidence interval for the forecast value at the given timestamp.", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "mean_value" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "description" : "Estimate for the mean forecast value at the given timestamp.", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "high_value" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "description" : "Estimate of the upper bound of the 95% confidence interval for the forecast value at the given timestamp.", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| } | |
| } | |
| }, | |
| "appliance_time_to_full_response" : { | |
| "type" : "object", | |
| "properties" : { | |
| "appliance_id" : { | |
| "type" : "string", | |
| "description" : "Unique ID of appliance." | |
| }, | |
| "end_of_forecast" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "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.\n" | |
| }, | |
| "time_to_full" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Estimated date-time at which the forecast value will reach full capacity." | |
| }, | |
| "time_to_full_pessimistic" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Pessimistic date-time for time to full based on the upper bound of the forecast 95% confidence interval." | |
| }, | |
| "time_to_full_optimistic" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Optimistic date-time for time to full based on the lower bound of the forecast 95% confidence interval." | |
| }, | |
| "time_to_full_status" : { | |
| "$ref" : "#/definitions/ForecastTimeToFullStatusEnum" | |
| }, | |
| "time_to_full_status_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to time_to_full_status" | |
| } | |
| } | |
| }, | |
| "cluster_time_to_full_response" : { | |
| "type" : "object", | |
| "properties" : { | |
| "cluster_id" : { | |
| "type" : "string", | |
| "description" : "Unique ID of the cluster." | |
| }, | |
| "end_of_forecast" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "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.\n" | |
| }, | |
| "time_to_full" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Estimated date-time at which the forecast value will reach full capacity." | |
| }, | |
| "time_to_full_pessimistic" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Pessimistic date-time for time to full based on the upper bound of the forecast 95% confidence interval." | |
| }, | |
| "time_to_full_optimistic" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Optimistic date-time for time to full based on the lower bound of the forecast 95% confidence interval." | |
| }, | |
| "time_to_full_status" : { | |
| "$ref" : "#/definitions/ForecastTimeToFullStatusEnum" | |
| }, | |
| "time_to_full_status_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to time_to_full_status" | |
| } | |
| } | |
| }, | |
| "FcPortSpeedEnum" : { | |
| "description" : "Possible Fibre Channel port speeds. For the current_speed attribute, these values show the current transmission speed on the port. \nFor the requested_speed attribute, these values show the transmission speed set by the user. A requested speed of Auto means that the current speed value will be automatically detected.\nIf this file is updated, also update FrontEndPortSpeedEnum.yaml\n* Auto - the speed value is automatically detected\n* 4_Gbps - 4 Gigabits per second\n* 8_Gbps - 8 Gigabits per second\n* 16_Gbps - 16 Gigabits per second\n* 32_Gbps - 32 Gigabits per second\n", | |
| "type" : "string", | |
| "enum" : [ "Auto", "4_Gbps", "8_Gbps", "16_Gbps", "32_Gbps" ], | |
| "x-display_enum_text" : { | |
| "Auto" : "Auto", | |
| "4_Gbps" : "4 Gbps", | |
| "8_Gbps" : "8 Gbps", | |
| "16_Gbps" : "16 Gbps", | |
| "32_Gbps" : "32 Gbps" | |
| } | |
| }, | |
| "fc_port_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "appliance_id", "wwn", "is_link_up", "current_speed" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the port.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "Name of the port. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "appliance_id" : { | |
| "description" : "Unique identifier of the appliance containing the port.", | |
| "type" : "string" | |
| }, | |
| "node_id" : { | |
| "description" : "Unique identifier of the hardware instance of type 'Node' containing the port.", | |
| "type" : "string" | |
| }, | |
| "wwn" : { | |
| "description" : "World Wide Name (WWN) of the port.", | |
| "type" : "string" | |
| }, | |
| "is_link_up" : { | |
| "description" : "Indicates whether the port's link is up. Values are:\n* true - Link is up.\n* false - Link is down.\n", | |
| "type" : "boolean" | |
| }, | |
| "supported_speeds" : { | |
| "description" : "List of supported transmission speeds for the port.", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/FcPortSpeedEnum" | |
| } | |
| }, | |
| "current_speed" : { | |
| "$ref" : "#/definitions/FcPortSpeedEnum" | |
| }, | |
| "requested_speed" : { | |
| "$ref" : "#/definitions/FcPortSpeedEnum" | |
| }, | |
| "sfp_id" : { | |
| "description" : "Unique identifier of the hardware instance of type 'SFP' (Small Form-factor Pluggable) inserted into the port.\n", | |
| "type" : "string" | |
| }, | |
| "io_module_id" : { | |
| "description" : "Unique identifier of the hardware instance of type 'IO_Module' handling the port.", | |
| "type" : "string" | |
| }, | |
| "port_index" : { | |
| "description" : "Index of the port in the IO module.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "port_connector_type" : { | |
| "$ref" : "#/definitions/FrontEndPortConnectionTypeEnum" | |
| }, | |
| "partner_id" : { | |
| "description" : "Unique identifier of the partner port.", | |
| "type" : "string" | |
| }, | |
| "supported_speeds_l10n" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "Localized message array corresponding to supported_speeds" | |
| }, | |
| "current_speed_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to current_speed" | |
| }, | |
| "requested_speed_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to requested_speed" | |
| }, | |
| "port_connector_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to port_connector_type" | |
| }, | |
| "appliance" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/appliance_instance", | |
| "description" : "This is the embeddable reference form of appliance_id attribute.", | |
| "x-ref" : "appliance" | |
| }, | |
| "node" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/hardware_instance", | |
| "description" : "This is the embeddable reference form of node_id attribute.", | |
| "x-ref" : "hardware" | |
| }, | |
| "sfp" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/hardware_instance", | |
| "description" : "This is the embeddable reference form of sfp_id attribute.", | |
| "x-ref" : "hardware" | |
| }, | |
| "io_module" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/hardware_instance", | |
| "description" : "This is the embeddable reference form of io_module_id attribute.", | |
| "x-ref" : "hardware" | |
| }, | |
| "partner" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/fc_port_instance", | |
| "description" : "This is the embeddable reference form of partner_id attribute.", | |
| "x-ref" : "fc_port" | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from appliance, hardware, fc_port" | |
| }, | |
| "fc_port_modify" : { | |
| "type" : "object", | |
| "required" : [ "requested_speed" ], | |
| "properties" : { | |
| "requested_speed" : { | |
| "$ref" : "#/definitions/FcPortSpeedEnum" | |
| } | |
| } | |
| }, | |
| "SasPortSpeedEnum" : { | |
| "description" : "SAS port transmission speed.\n* 3_Gbps- 3 Gigabits per second\n* 6_Gbps- 6 Gigabits per second\n* 12_Gbps- 12 Gigabits per second\n", | |
| "type" : "string", | |
| "enum" : [ "3_Gbps", "6_Gbps", "12_Gbps" ], | |
| "x-display_enum_text" : { | |
| "3_Gbps" : "3 Gbps", | |
| "6_Gbps" : "6 Gbps", | |
| "12_Gbps" : "12 Gbps" | |
| } | |
| }, | |
| "sas_port_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "appliance_id", "is_link_up" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the SAS port.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "Name of the SAS port. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "appliance_id" : { | |
| "description" : "Unique identifier of the appliance containing the port.", | |
| "type" : "string" | |
| }, | |
| "node_id" : { | |
| "description" : "Unique identifier of the hardware instance of type 'Node' containing the port.", | |
| "type" : "string" | |
| }, | |
| "is_link_up" : { | |
| "description" : "Indicates whether the SAS port's link is up. Values are:\n* true - Link is up.\n* false - Link is down.\n", | |
| "type" : "boolean" | |
| }, | |
| "speed" : { | |
| "$ref" : "#/definitions/SasPortSpeedEnum" | |
| }, | |
| "sfp_id" : { | |
| "description" : "Unique identifier of the hardware instance of type 'SFP' (Small Form-factor Pluggable) inserted into the port.\n", | |
| "type" : "string" | |
| }, | |
| "io_module_id" : { | |
| "description" : "Unique identifier of the hardware instance of type 'IO_Module' handling the port.", | |
| "type" : "string" | |
| }, | |
| "port_index" : { | |
| "description" : "Index of the SAS port in IO module.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "partner_id" : { | |
| "description" : "Unique identifier of the SAS partner port.", | |
| "type" : "string" | |
| }, | |
| "speed_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to speed" | |
| }, | |
| "appliance" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/appliance_instance", | |
| "description" : "This is the embeddable reference form of appliance_id attribute.", | |
| "x-ref" : "appliance" | |
| }, | |
| "node" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/hardware_instance", | |
| "description" : "This is the embeddable reference form of node_id attribute.", | |
| "x-ref" : "hardware" | |
| }, | |
| "sfp" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/hardware_instance", | |
| "description" : "This is the embeddable reference form of sfp_id attribute.", | |
| "x-ref" : "hardware" | |
| }, | |
| "io_module" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/hardware_instance", | |
| "description" : "This is the embeddable reference form of io_module_id attribute.", | |
| "x-ref" : "hardware" | |
| }, | |
| "partner" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/sas_port_instance", | |
| "description" : "This is the embeddable reference form of partner_id attribute.", | |
| "x-ref" : "sas_port" | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from appliance, hardware, sas_port" | |
| }, | |
| "EthPortSpeedEnum" : { | |
| "description" : "Supported Ethernet front-end port transmission speeds.\nFor the current_speed attribute, these values show the current transmission speed on the port.\nFor the requested_speed attribute, these values show the transmission speed set by the user. A requested speed of Auto means that the current speed value will be automatically detected.\nIf this file is updated, also update FrontEndPortSpeedEnum.yaml\n* Auto - the speed value is automatically detected\n* 10_Mbps - 10 Megabits per second\n* 100_Mbps - 100 Megabits per second\n* 1_Gbps - 1 Gigabits per second\n* 10_Gbps - 10 Gigabits per second\n* 25_Gbps - 25 Gigabits per second\n* 40_Gbps - 40 Gigabits per second\n", | |
| "type" : "string", | |
| "enum" : [ "Auto", "10_Mbps", "100_Mbps", "1_Gbps", "10_Gbps", "25_Gbps", "40_Gbps" ], | |
| "x-display_enum_text" : { | |
| "Auto" : "Auto", | |
| "10_Mbps" : "10 Mbps", | |
| "100_Mbps" : "100 Mbps", | |
| "1_Gbps" : "1 Gbps", | |
| "10_Gbps" : "10 Gbps", | |
| "25_Gbps" : "25 Gbps", | |
| "40_Gbps" : "40 Gbps" | |
| } | |
| }, | |
| "eth_port_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "appliance_id", "mac_address", "is_link_up", "current_speed", "current_mtu", "hypervisor_port_name" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Ethernet port instance identifier.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "Ethernet port name. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "appliance_id" : { | |
| "description" : "The id of the appliance containing the port.", | |
| "type" : "string" | |
| }, | |
| "node_id" : { | |
| "description" : "Unique identifier of the hardware instance of type 'Node' containing the port.", | |
| "type" : "string" | |
| }, | |
| "bond_id" : { | |
| "description" : "Unique identifier of the bond containing the port, or null if the port is not in a bond.", | |
| "type" : "string" | |
| }, | |
| "mac_address" : { | |
| "description" : "Ethernet port MAC address.", | |
| "type" : "string" | |
| }, | |
| "is_link_up" : { | |
| "description" : "Indicates whether the Ethernet port's link is up. Values are:\n* true - Link is up.\n* false - Link is down.\n", | |
| "type" : "boolean" | |
| }, | |
| "supported_speeds" : { | |
| "description" : "The list of supported transmission speeds for Ethernet port.", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EthPortSpeedEnum" | |
| } | |
| }, | |
| "current_speed" : { | |
| "$ref" : "#/definitions/EthPortSpeedEnum" | |
| }, | |
| "requested_speed" : { | |
| "$ref" : "#/definitions/EthPortSpeedEnum" | |
| }, | |
| "current_mtu" : { | |
| "description" : "The Maximum transmission unit (MTU) packet size that the Ethernet port can transmit.\nThe fabric MTU can be set to any value in the range [1500-9000].\nThe network MTU can be set to any value in the range [1280-9000].\nThe network MTU must be less than or equal to the current fabric MTU.\n", | |
| "type" : "integer", | |
| "minimum" : 1280, | |
| "maximum" : 9000, | |
| "format" : "int32" | |
| }, | |
| "sfp_id" : { | |
| "description" : "Unique identifier of the hardware instance of type 'SFP' (Small Form-factor Pluggable) inserted into the port.\n", | |
| "type" : "string" | |
| }, | |
| "io_module_id" : { | |
| "description" : "Unique identifier of the hardware instance of type 'IO_Module' handling the port.", | |
| "type" : "string" | |
| }, | |
| "port_index" : { | |
| "description" : "The index of the Ethernet port in IO module.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "port_connector_type" : { | |
| "$ref" : "#/definitions/FrontEndPortConnectionTypeEnum" | |
| }, | |
| "partner_id" : { | |
| "description" : "Unique identifier of the partner port instance.", | |
| "type" : "string" | |
| }, | |
| "is_hypervisor_managed" : { | |
| "description" : "Indicates whether the port is managed by a hypervisor.", | |
| "type" : "boolean" | |
| }, | |
| "hypervisor_port_name" : { | |
| "description" : "Hypervisor front-end port name capabilities. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "hypervisor_vswitch_name" : { | |
| "description" : "Name of the virtual switch associated with the hypervisor port. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "hypervisor_port_id" : { | |
| "description" : "Unique identifier of the virtual switch port associated with the hypervisor port.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "hypervisor_vswitch_id" : { | |
| "description" : "Unique identifier of the virtual switch associated with the hypervisor port.", | |
| "type" : "string" | |
| }, | |
| "supported_speeds_l10n" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "Localized message array corresponding to supported_speeds" | |
| }, | |
| "current_speed_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to current_speed" | |
| }, | |
| "requested_speed_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to requested_speed" | |
| }, | |
| "port_connector_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to port_connector_type" | |
| }, | |
| "ip_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ip_port_instance", | |
| "x-ref" : "ip_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type ip_port association." | |
| }, | |
| "appliance" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/appliance_instance", | |
| "description" : "This is the embeddable reference form of appliance_id attribute.", | |
| "x-ref" : "appliance" | |
| }, | |
| "node" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/hardware_instance", | |
| "description" : "This is the embeddable reference form of node_id attribute.", | |
| "x-ref" : "hardware" | |
| }, | |
| "bond" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/bond_instance", | |
| "description" : "This is the embeddable reference form of bond_id attribute.", | |
| "x-ref" : "bond" | |
| }, | |
| "sfp" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/hardware_instance", | |
| "description" : "This is the embeddable reference form of sfp_id attribute.", | |
| "x-ref" : "hardware" | |
| }, | |
| "io_module" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/hardware_instance", | |
| "description" : "This is the embeddable reference form of io_module_id attribute.", | |
| "x-ref" : "hardware" | |
| }, | |
| "partner" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/eth_port_instance", | |
| "description" : "This is the embeddable reference form of partner_id attribute.", | |
| "x-ref" : "eth_port" | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from ip_port, appliance, hardware, bond, eth_port" | |
| }, | |
| "FrontEndPortConnectionTypeEnum" : { | |
| "description" : "Type of connector supported by the port. Current values are:\n * Unknown - Unknown Connector\n * SC - Subscriber Connector\n * FC_Style1_Copper - Fibre Channel Style 1 Copper Connector\n * FC_Style2_Copper - Fibre Channel Style 1 Copper Connector\n * BNC_TNC - Bayonet/Threaded Neill-Concelman Connector\n * FC_Coaxial_Headers - Fibre Channel Coaxial Headers Connector\n * FiberJack - Fiber Jack Connector\n * LC - Lucent Connector\n * MT_RJ - Mechanical Transfer - Registered Jack Connector\n * MU - Multiple Optical Connector\n * SG - SG Connector\n * Optical_Pigtail - Optical Pigtail Connector\n * HSSDC_II - High Speed Serial Data Connector\n * Copper_Pigtail - Copper Pigtail Connector\n * RJ45 - RJ45 Connector\n * No_Separable - No Separable Connector\n * MXC_2x16 - MXC 2x16 Connector\n", | |
| "type" : "string", | |
| "enum" : [ "Unknown", "SC", "FC_Style1_Copper", "FC_Style2_Copper", "BNC_TNC", "FC_Coaxial_Headers", "FiberJack", "LC", "MT_RJ", "MU", "SG", "Optical_Pigtail", "HSSDC_II", "Copper_Pigtail", "RJ45", "No_Separable", "MXC_2x16" ], | |
| "x-display_enum_text" : { | |
| "Unknown" : "Unknown", | |
| "SC" : "SC", | |
| "FC_Style1_Copper" : "FC Style1 Copper", | |
| "FC_Style2_Copper" : "FC Style2 Copper", | |
| "BNC_TNC" : "BNC TNC", | |
| "FC_Coaxial_Headers" : "FC Coaxial Headers", | |
| "FiberJack" : "FiberJack", | |
| "LC" : "LC", | |
| "MT_RJ" : "MT RJ", | |
| "MU" : "MU", | |
| "SG" : "SG", | |
| "Optical_Pigtail" : "Optical Pigtail", | |
| "HSSDC_II" : "HSSDC II", | |
| "Copper_Pigtail" : "Copper Pigtail", | |
| "RJ45" : "RJ45", | |
| "No_Separable" : "No Separable Connector", | |
| "MXC_2x16" : "MXC 2x16" | |
| } | |
| }, | |
| "eth_port_modify" : { | |
| "type" : "object", | |
| "required" : [ "requested_speed" ], | |
| "properties" : { | |
| "requested_speed" : { | |
| "$ref" : "#/definitions/EthPortSpeedEnum" | |
| } | |
| } | |
| }, | |
| "CopySessionTypeEnum" : { | |
| "description" : "Session types.", | |
| "type" : "string", | |
| "enum" : [ "import_session", "migration_session", "replication_session" ], | |
| "x-display_enum_text" : { | |
| "import_session" : "Import Session", | |
| "migration_session" : "Migration Session", | |
| "replication_session" : "Replication Session" | |
| } | |
| }, | |
| "copy_metrics_by_appliance" : { | |
| "type" : "object", | |
| "description" : "Copy metrics for the appliance.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_copy_metrics_by_appliance" | |
| } ] | |
| }, | |
| "copy_metrics_by_cluster" : { | |
| "type" : "object", | |
| "description" : "Copy metrics for the cluster.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_copy_metrics_by_cluster" | |
| } ] | |
| }, | |
| "copy_metrics_by_vg" : { | |
| "type" : "object", | |
| "description" : "Cluster wide copy metrics for the volume group.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_copy_metrics_by_vg" | |
| } ] | |
| }, | |
| "copy_metrics_by_remote_system" : { | |
| "type" : "object", | |
| "description" : "Cluster wide copy metrics for the remote system.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_copy_metrics_by_remote_system" | |
| } ] | |
| }, | |
| "copy_metrics_by_volume" : { | |
| "type" : "object", | |
| "description" : "Cluster wide copy metrics for the volume.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_copy_metrics_by_volume" | |
| } ] | |
| }, | |
| "keystore_archive_instance" : { | |
| "description" : "A keystore archive file.", | |
| "properties" : { | |
| "data" : { | |
| "description" : "A keystore archive file which includes the individual keystore backup files from each appliance in the cluster.", | |
| "type" : "string", | |
| "format" : "binary" | |
| } | |
| } | |
| }, | |
| "keystore_archive_regenerate_response" : { | |
| "type" : "object", | |
| "description" : "Success response body.", | |
| "properties" : { | |
| "download_uri" : { | |
| "type" : "string", | |
| "description" : "A Uniform Resource Identifier which can be used in a subsequent GET request to download the keystore backup archive file." | |
| } | |
| } | |
| }, | |
| "software_package_install" : { | |
| "description" : "Install the software package.", | |
| "type" : "object", | |
| "properties" : { } | |
| }, | |
| "software_installed_instance" : { | |
| "description" : "Summary of the software packages that are installed on each appliance, or on the cluster as a whole.\r\nThis resource type has queriable association from appliance", | |
| "x-select_cli" : [ "id", "release_version", "installed_date", "appliance.id" ], | |
| "type" : "object", | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the installed software instance." | |
| }, | |
| "is_cluster" : { | |
| "type" : "boolean", | |
| "description" : "Whether this information represents the common software release version that is supported on all appliances in the cluster. The value is true for the instance representing the cluster. The value is false for appliance software instances." | |
| }, | |
| "release_version" : { | |
| "type" : "string", | |
| "description" : "Version of the installed release software package release." | |
| }, | |
| "release_timestamp" : { | |
| "type" : "string", | |
| "description" : "Date and time when this software package was produced.", | |
| "format" : "date-time" | |
| }, | |
| "installed_date" : { | |
| "type" : "string", | |
| "description" : "Date and time when the software was successfully installed and committed on the cluster. If the software package has not been commited, this value is null.", | |
| "format" : "date-time" | |
| }, | |
| "appliance" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/appliance_instance", | |
| "description" : "This is the embeddable reference form of appliance_id attribute.", | |
| "x-ref" : "appliance" | |
| } | |
| } | |
| }, | |
| "software_package_instance" : { | |
| "description" : "A software package contains all of the content required to upgrade the cluster to the version specified in the release_version property.", | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "description_l10n", "software_package_type", "size", "is_reboot_required", "release_version" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the software package." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the software package. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "description_l10n" : { | |
| "type" : "string", | |
| "description" : "Summary of the contents in this package." | |
| }, | |
| "justification_l10n" : { | |
| "type" : "string", | |
| "description" : "Explanation of why this software release is recommended for this cluster." | |
| }, | |
| "software_package_type" : { | |
| "$ref" : "#/definitions/SoftwarePackageTypeEnum" | |
| }, | |
| "software_package_state" : { | |
| "$ref" : "#/definitions/SoftwarePackageStateEnum" | |
| }, | |
| "size" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "description" : "File size of the software package in bytes.", | |
| "x-units" : "bytes", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "is_reboot_required" : { | |
| "type" : "boolean", | |
| "description" : "Whether a reboot is required during the upgrade process." | |
| }, | |
| "release_version" : { | |
| "type" : "string", | |
| "description" : "Version number of the software package." | |
| }, | |
| "release_timestamp" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Date and time when this software package was produced." | |
| }, | |
| "installed_date" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Date and time when this software package was successfully installed and committed on the cluster. If the software package has not been committed, this value is null." | |
| }, | |
| "software_package_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to software_package_type" | |
| }, | |
| "software_package_state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to software_package_state" | |
| } | |
| } | |
| }, | |
| "SoftwarePackageTypeEnum" : { | |
| "type" : "string", | |
| "description" : "Software package type. Valid values are:\n* Software_Release - A package containing a complete system software upgrade release.\n* Disk_Firmware - A package containing disk firmware updates only, for some or all supported drive types.\n* Hotfix - A package containing high priority firmware updates.\n* Language_Pack - A package containing additional language definitions.\n", | |
| "enum" : [ "Software_Release", "Disk_Firmware", "Hotfix", "Language_Pack" ], | |
| "x-display_enum_text" : { | |
| "Software_Release" : "Software Release", | |
| "Disk_Firmware" : "Disk Firmware", | |
| "Hotfix" : "Hotfix", | |
| "Language_Pack" : "Language Pack" | |
| } | |
| }, | |
| "SoftwarePackageStateEnum" : { | |
| "type" : "string", | |
| "description" : "Software package state. Valid values are:\n* Available - The package is ready to be downloaded.\n* Downloaded - The package is downloaded and ready to install.\n* Installing - The package is being installed.\n* Installed - The package has been successfully installed.\n* Install_Failed - Installing the package failed.\n* Download_Failed - Downloading the package failed.\n", | |
| "enum" : [ "Available", "Downloaded", "Installing", "Installed", "Install_Failed", "Download_Failed" ], | |
| "x-display_enum_text" : { | |
| "Available" : "Available", | |
| "Downloaded" : "Downloaded", | |
| "Installing" : "Installing", | |
| "Installed" : "Installed", | |
| "Install_Failed" : "Install failed", | |
| "Download_Failed" : "Download failed" | |
| } | |
| }, | |
| "migration_session_instance" : { | |
| "title" : "migration_session_instance", | |
| "description" : "A migration session.\r\nThis resource type has queriable associations from virtual_volume, volume, replication_session, volume_group", | |
| "x-select_cli" : [ "id", "name", "resource_type", "source_appliance_id", "destination_appliance_id", "state", "progress_percentage", "estimated_completion_timestamp" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the migration session instance.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "User-specified friendly name of the migration session instance. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "resource_type" : { | |
| "$ref" : "#/definitions/MigrationResourceTypeEnum" | |
| }, | |
| "source_appliance_id" : { | |
| "description" : "Unique identifier of the source appliance instance.", | |
| "type" : "string" | |
| }, | |
| "family_id" : { | |
| "description" : "Family identifier designating the storage resource or resources being migrated. For volume or virtual_volume migrations, the family is moved together because they share data among the primary object, snapshots, and clones. For volume_group migration, the family of each volume in the group is moved because it is a grouping of volumes.", | |
| "type" : "string" | |
| }, | |
| "destination_appliance_id" : { | |
| "description" : "Unique identifier of the destination appliance instance.", | |
| "type" : "string" | |
| }, | |
| "state" : { | |
| "$ref" : "#/definitions/MigrationSessionStateEnum" | |
| }, | |
| "created_timestamp" : { | |
| "description" : "Time when the migration session was created.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "last_sync_timestamp" : { | |
| "description" : "Time of the last successful sync operation.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "current_transfer_rate" : { | |
| "description" : "Transfer rate of the current sync operation in bytes/sec.", | |
| "type" : "integer", | |
| "format" : "int64", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "progress_percentage" : { | |
| "description" : "Progress percentage of the current sync operation.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "estimated_completion_timestamp" : { | |
| "description" : "Estimated completion time of the current sync operation.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "resource_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to resource_type" | |
| }, | |
| "state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to state" | |
| }, | |
| "virtual_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/virtual_volume_instance", | |
| "x-ref" : "virtual_volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type virtual_volume association." | |
| }, | |
| "volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/volume_instance", | |
| "x-ref" : "volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type volume association." | |
| }, | |
| "replication_sessions" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/replication_session_instance", | |
| "x-ref" : "replication_session_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type replication_session association." | |
| }, | |
| "volume_groups" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/volume_group_instance", | |
| "x-ref" : "volume_group_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type volume_group association." | |
| } | |
| } | |
| }, | |
| "MigrationResourceTypeEnum" : { | |
| "title" : "MigrationResourceTypeEnum", | |
| "description" : "Storage resource types eligible for migration.", | |
| "type" : "string", | |
| "enum" : [ "volume", "virtual_volume", "volume_group" ], | |
| "x-display_enum_text" : { | |
| "volume" : "Volume", | |
| "virtual_volume" : "Virtual Volume", | |
| "volume_group" : "Volume Group" | |
| } | |
| }, | |
| "MigrationSessionStateEnum" : { | |
| "description" : "Migration session states. \n * Initializing: Migration session starts and stays in this state until the session initialization completes. \n * Initialized: Migration session transitions to this state when session initialization completes. \n * Synchronizing: Background copy is in progress. \n * Idle: Migration session transitions to this state when initial background copy completes. \n * Cutting_Over: Final phase of the migration, when ownership of the volume, vVol, or application group is transferred to the new appliance.\n * Deleting: Migration session is being deleted. \n * Completed: Migration session is complete and it is safe to delete the session. \n * Pausing: Migration session transitions to this state when the pause command is issued. \n * Paused: Migration session is paused. User intervention is required to resume the session. \n * System_Paused: Migration session transitions to this state if it encounters any error. User may resume or delete the migration session after resolving the error. \n * Resuming: Migration session background copy being resumed. \n * Failed: Migration session encountered an error. ", | |
| "type" : "string", | |
| "enum" : [ "Initializing", "Initialized", "Synchronizing", "Idle", "Cutting_Over", "Deleting", "Completed", "Pausing", "Paused", "System_Paused", "Resuming", "Failed" ], | |
| "x-display_enum_text" : { | |
| "Initializing" : "Initializing", | |
| "Initialized" : "Initialized", | |
| "Synchronizing" : "Synchronizing", | |
| "Idle" : "Idle", | |
| "Cutting_Over" : "Cutting Over", | |
| "Deleting" : "Deleting", | |
| "Completed" : "Completed", | |
| "Pausing" : "Pausing", | |
| "Paused" : "Paused", | |
| "System_Paused" : "System Paused", | |
| "Resuming" : "Resuming", | |
| "Failed" : "Failed" | |
| } | |
| }, | |
| "migration_session_create" : { | |
| "type" : "object", | |
| "required" : [ "resource_type", "family_id", "destination_appliance_id" ], | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "User-specified friendly name of the migration session instance. The name can contain a maximum of 32 Unicode characters. It cannot contain unprintable characters, special HTTP characters, or whitespace." | |
| }, | |
| "resource_type" : { | |
| "$ref" : "#/definitions/MigrationResourceTypeEnum" | |
| }, | |
| "family_id" : { | |
| "type" : "string", | |
| "description" : "Family identifier designating the storage resource or resources to migrate. For volume or virtual_volume migrations, the family is moved together because they share data among the primary object, snapshots, and clones. For volume_group migration, the family of each volume in the group is moved because it is a grouping of volumes." | |
| }, | |
| "destination_appliance_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the destination appliance instance." | |
| }, | |
| "automatic_cutover" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "Indicates whether the migration session cutover is manual or automatic. Default for virtual_volume resource type migrations is automatic, otherwise the default is manual." | |
| } | |
| } | |
| }, | |
| "migration_session_sync" : { | |
| "type" : "object", | |
| "properties" : { | |
| "rescan_complete" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "Indicates whether a rescan will be performed during the sync operation. Default value is false. If the session creation completed with a message that rescan is required from one or more hosts, you must set this value to true during the subsequent sync operation. Otherwise, the sync operation will fail." | |
| }, | |
| "automatic_cutover" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "Indicates whether the migration session cutover is manual or automatic. Default is manual." | |
| } | |
| } | |
| }, | |
| "migration_session_delete" : { | |
| "type" : "object", | |
| "properties" : { | |
| "force" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "Indicates whether all migration activities will be canceled before deleting the session." | |
| } | |
| } | |
| }, | |
| "migration_session_create_response" : { | |
| "type" : "object", | |
| "description" : "The response for the create migration operation.", | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Identifier of the migration_session object." | |
| }, | |
| "rescan_host_ids" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "List of hosts that be rescanned before a migration session can proceed." | |
| } | |
| } | |
| }, | |
| "service_config_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "appliance_id", "is_ssh_enabled" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier for the service configuration instance." | |
| }, | |
| "appliance_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the appliance." | |
| }, | |
| "is_ssh_enabled" : { | |
| "type" : "boolean", | |
| "description" : "The current ssh service access state.\n* true - SSH access is enabled\n* false - SSH access is disabled" | |
| } | |
| } | |
| }, | |
| "service_config_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "is_ssh_enabled" : { | |
| "type" : "boolean", | |
| "description" : "Current SSH service access state.\n* true - Enables SSH access\n* false - Disables SSH access" | |
| } | |
| }, | |
| "required" : [ "is_ssh_enabled" ] | |
| }, | |
| "PolicyTypeEnum" : { | |
| "description" : "Supported policy types.\n * Protection - A protection policy, consisting of snapshot and replication rules.\n * Performance - A performance policy, consisting of performance rules.\n", | |
| "type" : "string", | |
| "enum" : [ "Protection", "Performance" ], | |
| "x-display_enum_text" : { | |
| "Protection" : "Protection", | |
| "Performance" : "Performance" | |
| } | |
| }, | |
| "policy_instance" : { | |
| "type" : "object", | |
| "description" : "Properties of a policy.\r\nThis resource type has queriable associations from performance_rule, snapshot_rule, replication_rule, virtual_machine, volume, volume_group, file_system", | |
| "x-select_cli" : [ "id", "name", "description", "type" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the policy.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "Policy name. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "description" : { | |
| "description" : "Policy description.", | |
| "type" : "string" | |
| }, | |
| "type" : { | |
| "$ref" : "#/definitions/PolicyTypeEnum" | |
| }, | |
| "is_replica" : { | |
| "description" : "Indicates whether this is a replica policy, which is applied to replication destination storage resources. A policy of this type is restricted from many operations.\n", | |
| "type" : "boolean", | |
| "default" : false | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "virtual_machines" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/virtual_machine_instance", | |
| "x-ref" : "virtual_machine_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type virtual_machine association." | |
| }, | |
| "volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/volume_instance", | |
| "x-ref" : "volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type volume association." | |
| }, | |
| "volume_groups" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/volume_group_instance", | |
| "x-ref" : "volume_group_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type volume_group association." | |
| }, | |
| "file_systems" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_system_instance", | |
| "x-ref" : "file_system_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type file_system association." | |
| }, | |
| "performance_rules" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/performance_rule_instance", | |
| "x-ref" : "performance_rule" | |
| }, | |
| "description" : "List of the performance_rules that are associated with this policy." | |
| }, | |
| "snapshot_rules" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/snapshot_rule_instance", | |
| "x-ref" : "snapshot_rule" | |
| }, | |
| "description" : "List of the snapshot_rules that are associated with this policy." | |
| }, | |
| "replication_rules" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/replication_rule_instance", | |
| "x-ref" : "replication_rule" | |
| }, | |
| "description" : "List of the replication_rules that are associated with this policy." | |
| } | |
| } | |
| }, | |
| "policy_create" : { | |
| "type" : "object", | |
| "description" : "Policy create request.", | |
| "required" : [ "name" ], | |
| "properties" : { | |
| "name" : { | |
| "description" : "Policy name.", | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "description" : "Policy description.", | |
| "type" : "string" | |
| }, | |
| "snapshot_rule_ids" : { | |
| "description" : "Snapshot rule identifiers included in this policy. At least one snapshot rule or one replication rule must be specified to create a protection policy.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "replication_rule_ids" : { | |
| "description" : "Replication rule identifiers included in this policy. At least one snapshot rule or one replication rule must be specified to create a protection policy.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| }, | |
| "policy_modify" : { | |
| "type" : "object", | |
| "description" : "Policy modify request.", | |
| "properties" : { | |
| "name" : { | |
| "description" : "Policy name.", | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "description" : "Policy description.", | |
| "type" : "string" | |
| }, | |
| "snapshot_rule_ids" : { | |
| "description" : "Snapshot rule identifiers that should replace the current list of snapshot rule identifiers in this policy.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "replication_rule_ids" : { | |
| "description" : "Replication rule identifiers that should replace the current list of replication rule identifiers in this policy.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "add_snapshot_rule_ids" : { | |
| "description" : "Snapshot rule identifiers to be added to this policy.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "add_replication_rule_ids" : { | |
| "description" : "Replication rule identifiers to be added to this policy.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "remove_snapshot_rule_ids" : { | |
| "description" : "Snapshot rule identifiers to be removed from this policy.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "remove_replication_rule_ids" : { | |
| "description" : "Replication rule identifiers to be removed from this policy.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SnapRuleIntervalEnum" : { | |
| "description" : "Interval between snapshots. Either the interval parameter or the time_of_day parameter may be set. Setting one clears the other parameter.", | |
| "type" : "string", | |
| "enum" : [ "Five_Minutes", "Fifteen_Minutes", "Thirty_Minutes", "One_Hour", "Two_Hours", "Three_Hours", "Four_Hours", "Six_Hours", "Eight_Hours", "Twelve_Hours", "One_Day" ], | |
| "x-display_enum_text" : { | |
| "Five_Minutes" : "Five Minutes", | |
| "Fifteen_Minutes" : "Fifteen Minutes", | |
| "Thirty_Minutes" : "Thirty Minutes", | |
| "One_Hour" : "One Hour", | |
| "Two_Hours" : "Two Hours", | |
| "Three_Hours" : "Three Hours", | |
| "Four_Hours" : "Four Hours", | |
| "Six_Hours" : "Six Hours", | |
| "Eight_Hours" : "Eight Hours", | |
| "Twelve_Hours" : "Twelve Hours", | |
| "One_Day" : "One Day" | |
| } | |
| }, | |
| "DaysOfWeekEnum" : { | |
| "description" : "Days of the week.", | |
| "type" : "string", | |
| "enum" : [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], | |
| "x-display_enum_text" : { | |
| "Monday" : "Monday", | |
| "Tuesday" : "Tuesday", | |
| "Wednesday" : "Wednesday", | |
| "Thursday" : "Thursday", | |
| "Friday" : "Friday", | |
| "Saturday" : "Saturday", | |
| "Sunday" : "Sunday" | |
| } | |
| }, | |
| "snapshot_rule_instance" : { | |
| "type" : "object", | |
| "description" : "Snapshot rule instance.\r\nThis resource type has queriable association from policy", | |
| "x-select_cli" : [ "id", "name", "interval", "time_of_day", "days_of_week", "desired_retention", "policies.name" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the snapshot rule.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "Snapshot rule name. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "interval" : { | |
| "$ref" : "#/definitions/SnapRuleIntervalEnum" | |
| }, | |
| "time_of_day" : { | |
| "description" : "Time of the day to take a daily snapshot, with format \"hh:mm\" in 24 hour time format. Either the interval parameter or the time_of_day parameter will be set, but not both.\n", | |
| "type" : "string", | |
| "format" : "timestamp" | |
| }, | |
| "days_of_week" : { | |
| "description" : "Days of the week when the rule should be applied. Applies only for rules where the time_of_day parameter is set.\n", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/DaysOfWeekEnum" | |
| } | |
| }, | |
| "desired_retention" : { | |
| "description" : "Desired snapshot retention period in hours. The system will retain snapshots for this time period, if space is available.\n", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "is_replica" : { | |
| "description" : "Indicates if this is a replica of a rule or policy on a remote system that is the source of a replication session replicating a resource to the local system.\n", | |
| "type" : "boolean", | |
| "default" : false | |
| }, | |
| "interval_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to interval" | |
| }, | |
| "days_of_week_l10n" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "Localized message array corresponding to days_of_week" | |
| }, | |
| "policies" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/policy_instance", | |
| "x-ref" : "policy" | |
| }, | |
| "description" : "List of the policies that are associated with this snapshot_rule." | |
| } | |
| } | |
| }, | |
| "snapshot_rule_create" : { | |
| "type" : "object", | |
| "required" : [ "name", "desired_retention" ], | |
| "description" : "Snapshot rule create request.", | |
| "properties" : { | |
| "name" : { | |
| "description" : "Snapshot rule name.", | |
| "type" : "string" | |
| }, | |
| "interval" : { | |
| "$ref" : "#/definitions/SnapRuleIntervalEnum" | |
| }, | |
| "time_of_day" : { | |
| "description" : "Time of the day to take a daily snapshot, with format \"hh:mm\" in 24 hour time format. Either the interval parameter or the time_of_day parameter may be set, but not both.\n", | |
| "type" : "string", | |
| "format" : "timestamp" | |
| }, | |
| "days_of_week" : { | |
| "description" : "Days of the week when the rule should be applied. Applies only for rules where the time_of_day parameter is set.\n", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/DaysOfWeekEnum" | |
| } | |
| }, | |
| "desired_retention" : { | |
| "description" : "Desired snapshot retention period in hours. The system will retain snapshots for this time period, if space is available.\n", | |
| "type" : "integer", | |
| "minimum" : 1, | |
| "maximum" : 8760, | |
| "format" : "int32" | |
| } | |
| } | |
| }, | |
| "snapshot_rule_modify" : { | |
| "type" : "object", | |
| "description" : "Snapshot rule modify request.", | |
| "properties" : { | |
| "name" : { | |
| "description" : "Snapshot rule name.", | |
| "type" : "string" | |
| }, | |
| "interval" : { | |
| "$ref" : "#/definitions/SnapRuleIntervalEnum" | |
| }, | |
| "time_of_day" : { | |
| "description" : "Time of the day to take a daily snapshot, with format \"hh:mm\" in 24 hour time format. Either the interval parameter or the time_of_day parameter may be set, but not both.\n", | |
| "type" : "string", | |
| "format" : "timestamp" | |
| }, | |
| "days_of_week" : { | |
| "description" : "Days of the week when the rule should be applied. Applies only for rules where the time_of_day parameter is set.\n", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/DaysOfWeekEnum" | |
| } | |
| }, | |
| "desired_retention" : { | |
| "description" : "Desired snapshot retention period in hours. The system will retain snapshots for this time period, if space is available.\n", | |
| "type" : "integer", | |
| "minimum" : 1, | |
| "maximum" : 8760, | |
| "format" : "int32" | |
| } | |
| } | |
| }, | |
| "snapshot_rule_delete" : { | |
| "type" : "object", | |
| "description" : "Snapshot rule delete request.", | |
| "properties" : { | |
| "delete_snaps" : { | |
| "description" : "Specify whether all snapshots previously created by this rule should also be deleted when this rule is removed.", | |
| "type" : "boolean", | |
| "default" : false | |
| } | |
| } | |
| }, | |
| "RPOEnum" : { | |
| "description" : "Recovery point objective (RPO), which is the acceptable amount of data, measured in units of time, that may be lost in case of a failure.", | |
| "type" : "string", | |
| "enum" : [ "Five_Minutes", "Fifteen_Minutes", "Thirty_Minutes", "One_Hour", "Six_Hours", "Twelve_Hours", "One_Day" ], | |
| "x-display_enum_text" : { | |
| "Five_Minutes" : "Five Minutes", | |
| "Fifteen_Minutes" : "Fifteen Minutes", | |
| "Thirty_Minutes" : "Thirty Minutes", | |
| "One_Hour" : "One Hour", | |
| "Six_Hours" : "Six Hours", | |
| "Twelve_Hours" : "Twelve Hours", | |
| "One_Day" : "One Day" | |
| } | |
| }, | |
| "replication_rule_instance" : { | |
| "type" : "object", | |
| "description" : "Properties of the replication rule.\r\nThis resource type has queriable associations from policy, replication_session", | |
| "x-select_cli" : [ "id", "name", "rpo", "remote_system_id", "is_replica", "policies.name" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the replication rule.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "Name of the replication rule. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "rpo" : { | |
| "$ref" : "#/definitions/RPOEnum" | |
| }, | |
| "remote_system_id" : { | |
| "description" : "Unique identifier of the remote system to which this rule will replicate the associated resources.\n", | |
| "type" : "string" | |
| }, | |
| "is_replica" : { | |
| "description" : "Indicates if this is a replica of a rule or policy on a remote system that is the source of a replication session replicating a resource to the local system.\n", | |
| "type" : "boolean", | |
| "default" : false | |
| }, | |
| "alert_threshold" : { | |
| "description" : "Acceptable delay in minutes between the expected and actual replication sync intervals. The system generates an alert if the delay between the expected and actual sync exceeds this threshold. Alert threshold has the default value of one RPO in minutes.\n", | |
| "type" : "integer", | |
| "minimum" : 0, | |
| "maximum" : 1440, | |
| "format" : "int32" | |
| }, | |
| "rpo_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to rpo" | |
| }, | |
| "replication_sessions" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/replication_session_instance", | |
| "x-ref" : "replication_session_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type replication_session association." | |
| }, | |
| "policies" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/policy_instance", | |
| "x-ref" : "policy" | |
| }, | |
| "description" : "List of the policies that are associated with this replication_rule." | |
| } | |
| } | |
| }, | |
| "replication_rule_create" : { | |
| "type" : "object", | |
| "description" : "Replication rule create request.", | |
| "required" : [ "name", "rpo", "remote_system_id" ], | |
| "properties" : { | |
| "name" : { | |
| "description" : "Name of the replication rule.", | |
| "type" : "string" | |
| }, | |
| "rpo" : { | |
| "$ref" : "#/definitions/RPOEnum" | |
| }, | |
| "remote_system_id" : { | |
| "description" : "Unique identifier of the remote system to which this rule will replicate the associated resources.\n", | |
| "type" : "string" | |
| }, | |
| "alert_threshold" : { | |
| "description" : "Acceptable delay in minutes between the expected and actual replication sync intervals. The system generates an alert if the delay between the expected and actual sync exceeds this threshold. Alert threshold has the default value of one RPO in minutes.\n", | |
| "type" : "integer", | |
| "minimum" : 0, | |
| "maximum" : 1440, | |
| "format" : "int32" | |
| } | |
| } | |
| }, | |
| "replication_rule_modify" : { | |
| "type" : "object", | |
| "description" : "Replication rule modify request.", | |
| "properties" : { | |
| "name" : { | |
| "description" : "Name of the replication rule.", | |
| "type" : "string" | |
| }, | |
| "rpo" : { | |
| "$ref" : "#/definitions/RPOEnum" | |
| }, | |
| "remote_system_id" : { | |
| "description" : "Unique identifier of the remote system to which this rule will replicate the associated resources.\n", | |
| "type" : "string" | |
| }, | |
| "alert_threshold" : { | |
| "description" : "Acceptable delay in minutes between the expected and actual replication sync intervals. The system generates an alert if the delay between the expected and actual sync exceeds this threshold.\n", | |
| "type" : "integer", | |
| "minimum" : 0, | |
| "maximum" : 1440, | |
| "format" : "int32" | |
| } | |
| } | |
| }, | |
| "job_instance" : { | |
| "type" : "object", | |
| "description" : "Information about the job.\r\nThis resource type has queriable associations from job", | |
| "x-select_cli" : [ "id", "resource_type", "resource_name", "description_l10n", "state", "start_time", "end_time", "progress_percentage" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the job." | |
| }, | |
| "resource_action" : { | |
| "$ref" : "#/definitions/ResourceActionEnum" | |
| }, | |
| "resource_type" : { | |
| "$ref" : "#/definitions/ResourceTypeEnum" | |
| }, | |
| "resource_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource on which the job is operating." | |
| }, | |
| "resource_name" : { | |
| "type" : "string", | |
| "description" : "Name of the resource on which the job is operating. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "description_l10n" : { | |
| "type" : "string", | |
| "description" : "Description of the job." | |
| }, | |
| "state" : { | |
| "$ref" : "#/definitions/JobStateEnum" | |
| }, | |
| "start_time" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Date and time when the job execution started." | |
| }, | |
| "end_time" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Date and time when the job execution completed." | |
| }, | |
| "estimated_completion_time" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Estimated completion date and time." | |
| }, | |
| "progress_percentage" : { | |
| "type" : "integer", | |
| "description" : "Percent complete of the job.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "parent_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the parent job, if applicable." | |
| }, | |
| "root_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the root job, if applicable. The root job is the job at the top of the parent hierarchy." | |
| }, | |
| "user" : { | |
| "type" : "string", | |
| "description" : "Name of the user associated with the job." | |
| }, | |
| "response_body" : { | |
| "$ref" : "#/definitions/base_response" | |
| }, | |
| "step_order" : { | |
| "type" : "integer", | |
| "description" : "Order of a given job step with respect to its siblings within the job hierarchy.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "resource_action_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to resource_action" | |
| }, | |
| "resource_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to resource_type" | |
| }, | |
| "state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to state" | |
| }, | |
| "parent" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/job_instance", | |
| "description" : "This is the embeddable reference form of parent_id attribute.", | |
| "x-ref" : "job" | |
| }, | |
| "children" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/job_instance", | |
| "x-ref" : "job_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type job association." | |
| }, | |
| "root" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/job_instance", | |
| "description" : "This is the embeddable reference form of root_id attribute.", | |
| "x-ref" : "job" | |
| }, | |
| "leafs" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/job_instance", | |
| "x-ref" : "job_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type job association." | |
| } | |
| } | |
| }, | |
| "JobStateEnum" : { | |
| "type" : "string", | |
| "description" : "Current status of the job.", | |
| "enum" : [ "PENDING", "QUEUED", "IN_PROGRESS", "COMPLETED", "SKIPPED", "UNRECOVERABLE_FAILED", "FAILED" ], | |
| "x-display_enum_text" : { | |
| "PENDING" : "Pending", | |
| "QUEUED" : "Queued", | |
| "IN_PROGRESS" : "In Progress", | |
| "COMPLETED" : "Completed", | |
| "SKIPPED" : "Skipped", | |
| "UNRECOVERABLE_FAILED" : "Unrecoverable Failed", | |
| "FAILED" : "Failed" | |
| } | |
| }, | |
| "ResourceActionEnum" : { | |
| "type" : "string", | |
| "description" : "User-specified action to be performed on the given resource.", | |
| "enum" : [ "add_members", "attach", "bind", "cancel", "cleanup", "clone", "create", "create_migration_sessions", "cutover", "decommission", "delete", "detach", "discover", "download", "drive_repurpose", "exchange", "failover", "forecast", "generate", "import_snapshot_profiles", "import_snapshot_schedules", "install", "join", "modify", "mount", "pause", "ping", "puhc", "refresh", "refresh_quota", "regenerate", "remove_members", "replace", "reprotect", "restore", "resume", "retrieve", "scale", "snapshot", "start_migration_sessions", "sync", "test", "time_to_full", "unjoin", "unmount", "update_user_mappings", "upgrade", "upload", "upload_certificate", "upload_config", "upload_file", "upload_keytab", "verify" ], | |
| "x-display_enum_text" : { | |
| "add_members" : "add members", | |
| "attach" : "attach", | |
| "bind" : "bind", | |
| "cancel" : "cancel", | |
| "cleanup" : "cleanup", | |
| "clone" : "clone", | |
| "create" : "create", | |
| "create_migration_sessions" : "create migration sessions", | |
| "cutover" : "cutover", | |
| "decommission" : "decommission", | |
| "delete" : "delete", | |
| "detach" : "detach", | |
| "discover" : "discover", | |
| "download" : "download", | |
| "drive_repurpose" : "drive repurpose", | |
| "exchange" : "exchange", | |
| "failover" : "failover", | |
| "forecast" : "forecast", | |
| "generate" : "generate", | |
| "import_snapshot_profiles" : "import snapshot profiles", | |
| "import_snapshot_schedules" : "import snapshot schedules", | |
| "install" : "install", | |
| "join" : "join", | |
| "modify" : "modify", | |
| "mount" : "mount", | |
| "pause" : "pause", | |
| "ping" : "ping", | |
| "puhc" : "puhc", | |
| "refresh" : "refresh", | |
| "refresh_quota" : "refresh quota", | |
| "regenerate" : "regenerate", | |
| "remove_members" : "remove members", | |
| "replace" : "replace", | |
| "reprotect" : "reprotect", | |
| "restore" : "restore", | |
| "resume" : "resume", | |
| "retrieve" : "retrieve", | |
| "scale" : "scale", | |
| "snapshot" : "snapshot", | |
| "start_migration_sessions" : "start migration sessions", | |
| "sync" : "sync", | |
| "test" : "test", | |
| "time_to_full" : "time to full", | |
| "unjoin" : "unjoin", | |
| "unmount" : "unmount", | |
| "update_user_mappings" : "update user mappings", | |
| "upgrade" : "upgrade", | |
| "upload" : "upload", | |
| "upload_certificate" : "upload certificate", | |
| "upload_config" : "upload config", | |
| "upload_file" : "upload file", | |
| "upload_keytab" : "upload keytab", | |
| "verify" : "verify" | |
| } | |
| }, | |
| "migration_recommendation_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "created_timestamp", "state", "estimated_cost", "type", "migration_actions" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique ID of recommendation." | |
| }, | |
| "created_timestamp" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Time at which recommendation was created." | |
| }, | |
| "state" : { | |
| "$ref" : "#/definitions/MigrationRecommendationStateEnum" | |
| }, | |
| "estimated_cost" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "description" : "Unitless value describing estimated cost to migrate all volumes for this recommendation relative to other recommendations.", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "type" : { | |
| "description" : "Type of request that generated a migration recommendation. Evacuate_Appliance - A recommendation to evacuate space by auto selecting storage objects from an appliance using specified size.\n", | |
| "$ref" : "#/definitions/MigrationRecommendationTypeEnum" | |
| }, | |
| "request_parameters" : { | |
| "$ref" : "#/definitions/migration_recommendation_create" | |
| }, | |
| "sessions_created_timestamp" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Time at which migration sessions were created for the recommendation. Null if migration sessions have not been created." | |
| }, | |
| "sessions_completed_timestamp" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Time at which all migration sessions for the recommendation were complete. Null if migration sessions have not been created/started or if any migration pursuant to the recommendation is still ongoing.\n" | |
| }, | |
| "rescan_host_list" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "IDs of hosts that must be rescanned after migration sessions are created but before migration sessions are started." | |
| }, | |
| "migration_actions" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/migration_recommendation_action" | |
| }, | |
| "description" : "Filtering on the fields of this embedded resource is not supported.", | |
| "x-no_filter" : true | |
| }, | |
| "state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to state" | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| } | |
| } | |
| }, | |
| "migration_recommendation_create" : { | |
| "type" : "object", | |
| "description" : "Set evacuate_appliance parameters to evacuate space \nFiltering on the fields of this embedded resource is not supported.", | |
| "required" : [ "evacuate_appliance" ], | |
| "properties" : { | |
| "evacuate_appliance" : { | |
| "description" : "Evacuate appliance by specifying optional space_to_free", | |
| "type" : "object", | |
| "required" : [ "appliance_id" ], | |
| "properties" : { | |
| "appliance_id" : { | |
| "type" : "string", | |
| "example" : "evac_from_appliance", | |
| "description" : "ID of appliance on which available space is desired." | |
| }, | |
| "space_to_free" : { | |
| "type" : "integer", | |
| "example" : 3000000000000, | |
| "description" : "Optional desired amount of used storage (in bytes) to move to other appliances. If space_to_free is not specified,\nspace to be freed is estimated by the system such that migrating objects equivalent to that much amount of storage\nspace would clear Major severity capacity alarm on the appliance. If there is no Major severity capacity alarm on\nan appliance and space_to_free is not specified, error will be returned.\nTo free up desired amount of space from an appliance, specify the amount of space greater than zero to be freed.\n", | |
| "x-units" : "bytes", | |
| "minimum" : 1, | |
| "format" : "int64" | |
| }, | |
| "target_appliance_ids" : { | |
| "type" : "array", | |
| "example" : [ "evac_to_appliance_1", "evac_to_appliance_2", "..." ], | |
| "description" : "Optional IDs of appliances to which used storage can be migrated for this request.\nIf no target appliances are specified, the evacuated objects can be placed on any appliance in the cluster.\n", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-no_filter" : true | |
| }, | |
| "migration_recommendation_action" : { | |
| "type" : "object", | |
| "description" : "A recommended migration action.", | |
| "required" : [ "resource_id", "resource_type", "src_appliance_id", "dst_appliance_id", "cost", "host_connectivity_to_destination", "action_state", "primary_id", "primary_name", "migration_primary_resource_type", "migration_reason" ], | |
| "properties" : { | |
| "resource_id" : { | |
| "type" : "string", | |
| "description" : "ID of storage resource migrated by this action." | |
| }, | |
| "resource_type" : { | |
| "$ref" : "#/definitions/MigrationResourceTypeEnum" | |
| }, | |
| "src_appliance_id" : { | |
| "type" : "string", | |
| "description" : "ID of appliance that is the source for this migration action." | |
| }, | |
| "dst_appliance_id" : { | |
| "type" : "string", | |
| "description" : "ID of appliance that is the destination for this migration action." | |
| }, | |
| "cost" : { | |
| "type" : "integer", | |
| "description" : "Unitless value describing estimated cost to perform relative to other migration actions.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "host_connectivity_to_destination" : { | |
| "type" : "boolean", | |
| "description" : "Whether all hosts for the migrating resource have connectivity to the destination appliance." | |
| }, | |
| "action_state" : { | |
| "$ref" : "#/definitions/MigrationRecommendationActionStateEnum" | |
| }, | |
| "primary_id" : { | |
| "type" : "string", | |
| "description" : "Unique ID of the primary object." | |
| }, | |
| "primary_name" : { | |
| "type" : "string", | |
| "description" : "Name of the primary object." | |
| }, | |
| "migration_primary_resource_type" : { | |
| "$ref" : "#/definitions/MigrationRecommendationPrimaryResourceTypeEnum" | |
| }, | |
| "migration_reason" : { | |
| "$ref" : "#/definitions/MigrationRecommendationReasonEnum" | |
| }, | |
| "resource_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to resource_type" | |
| }, | |
| "action_state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to action_state" | |
| }, | |
| "migration_primary_resource_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to migration_primary_resource_type" | |
| }, | |
| "migration_reason_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to migration_reason" | |
| } | |
| } | |
| }, | |
| "migration_recommendation_create_migration_sessions_response" : { | |
| "type" : "object", | |
| "properties" : { | |
| "migration_session_ids" : { | |
| "type" : "array", | |
| "description" : "ID of migration sessions created for the recommendation.", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "rescan_host_list" : { | |
| "type" : "array", | |
| "description" : "IDs of attached hosts that require a rescan to ensure accessibility of migrated\nstorage objects after migrations complete.\n", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| }, | |
| "MigrationRecommendationStateEnum" : { | |
| "type" : "string", | |
| "description" : "State of a migration recommendation.\n* Recommendation_Created - Recommended actions meet all request parameters.\n* Some_Actions_Recommended - Recommendation generated, but not all request parameters satisfied.\n* Migration_Session_Created - Migration sessions were successfully created for each recommended migration action.\n* Migration_Session_Create_Failed - A migration session could not be created for at least one recommended recommended actions.\n When an error is encountered while creating one of the sessions, the session creation for remaining migration actions will be aborted \n and error is returned. Sessions which are already created for this recommendation will be rolled back.\n After completing the roll-back, recommendation and all actions will be restored to Recommendation_Created state so that\n the recommendation can be applied again.\n* Migration_Started - All migration sessions successfully started.\n* Migration_Start_Failed - At least one migration session failed to start. Even if start (sync) migration operation fails on one of the sessions, \n RB will continue and attempt to start all sessions within that recommendation. Error will be returned.\n There will not be a roll back for any sync operation.\n* Migration_Paused - At least one migration session for this recommendation is paused. Paused migration sessions can be resumed manually.\n* Migration_Error - At least one migration session for this recommendation has failed.\n* Migration_Successful - All migration sessions have been successfully completed.\n", | |
| "enum" : [ "Recommendation_Created", "Some_Actions_Recommended", "Migration_Session_Created", "Migration_Session_Create_Failed", "Migration_Started", "Migration_Paused", "Migration_Error", "Migration_Successful" ], | |
| "x-display_enum_text" : { | |
| "Recommendation_Created" : "Recommendation Created", | |
| "Some_Actions_Recommended" : "Some Actions Recommended", | |
| "Migration_Session_Created" : "Migration Session Created", | |
| "Migration_Session_Create_Failed" : "Migration Session Create Failed", | |
| "Migration_Started" : "Migration Started", | |
| "Migration_Paused" : "Migration Paused", | |
| "Migration_Error" : "Migration Error", | |
| "Migration_Successful" : "Migration Successful" | |
| } | |
| }, | |
| "MigrationRecommendationActionStateEnum" : { | |
| "type" : "string", | |
| "description" : "State of a recommended migration action.\n* Recommendation_Created - This action has been recommended, but no other action has been taken.\n* Migration_Session_Created - A migration session was successfully created for this recommended action.\n* Migration_Session_Create_Failed - A migration session could not be created for this recommended action.\n* Migration_Started - The migration session for this recommended action was successfully started.\n* Migration_Start_Failed - The migration session for this recommended action failed to start.\n* Migration_Paused - The migration session for this recommended action is paused.\n* Migration_Error - The migration session for this recommended action has failed.\n* Migration_Successful - The migration session for this recommended action has been successfully completed.\n", | |
| "enum" : [ "Recommendation_Created", "Migration_Session_Created", "Migration_Session_Create_Failed", "Migration_Started", "Migration_Start_Failed", "Migration_Paused", "Migration_Error", "Migration_Successful" ], | |
| "x-display_enum_text" : { | |
| "Recommendation_Created" : "Recommendation Created", | |
| "Migration_Session_Created" : "Migration Session Created", | |
| "Migration_Session_Create_Failed" : "Migration Session Create Failed", | |
| "Migration_Started" : "Migration Started", | |
| "Migration_Start_Failed" : "Migration Start Failed", | |
| "Migration_Paused" : "Migration Paused", | |
| "Migration_Error" : "Migration Error", | |
| "Migration_Successful" : "Migration Successful" | |
| } | |
| }, | |
| "MigrationRecommendationTypeEnum" : { | |
| "type" : "string", | |
| "description" : "Type of request that generated a migration recommendation.\nEvacuate_Appliance - A recommendation to evacuate space by auto selecting storage objects from an appliance using specified size. \n", | |
| "enum" : [ "Evacuate_Appliance" ], | |
| "x-display_enum_text" : { | |
| "Evacuate_Appliance" : "Evacuate Appliance" | |
| } | |
| }, | |
| "MigrationRecommendationReasonEnum" : { | |
| "type" : "string", | |
| "description" : "Reason for migrating a specific resource.\n* No_Host_Attached - Resource is not attached to any host.\n* No_Virtual_Machine_Attached - Resource is not attached to any virtual machine.\n* Attached_To_Host - Resource is attached to host.\n* Attached_To_Virtual_Machine - Resource is attached to virtual machine.\n* Volume_Group_Member - Resource is a member of volume group.\n* Unspecified - Unspecified.\n", | |
| "enum" : [ "No_Host_Attached", "No_Virtual_Machine_Attached", "Attached_To_Host", "Attached_To_Virtual_Machine", "Volume_Group_Member", "Unspecified" ], | |
| "x-display_enum_text" : { | |
| "No_Host_Attached" : "Resource is not attached to any host", | |
| "No_Virtual_Machine_Attached" : "Resource is not attached to any virtual machine", | |
| "Attached_To_Host" : "Resource is attached to host", | |
| "Attached_To_Virtual_Machine" : "Resource is attached to virtual machine", | |
| "Volume_Group_Member" : "Resource is a member of volume group", | |
| "Unspecified" : "Unspecified" | |
| } | |
| }, | |
| "MigrationRecommendationPrimaryResourceTypeEnum" : { | |
| "type" : "string", | |
| "description" : "Specifies grouping mechanism for migration actions in a recommendation that identifies logically related migration actions.\nIf a volume/virtual volume is attached to a host/virtual machine and the system selects all volumes/virtual volumes attached\nto the same host/virtual machine for migration, the type is set to host/virtual_machine. If a volume/virtual volume is\nunattached or the system couldn't consider logical grouping, the group type is set to volume or virtual volume.\nFor volume group objects, the scope of migration is always volumes_group regardless of host attachment.\nThe order of selection for primary resource types is:\nResources without host/virtual_machine connectivity.\nResources with host/virtual_machine connectivity.\nResources in each of the above category are further ordered by decreasing cost of migration.\n\nValid scopes for migrations are:\n* volume - Standalone attached/unattached volume family.\n* virtual_volume - Standalone attached/unattached virtual volume family.\n* host - Logical group of all volume families attached to a host.\n* virtual_machine - Logical group of all virtual volume families attached to a virtual machine.\n* volume_group - Volume group family with or without host attachment.\n", | |
| "enum" : [ "volume", "virtual_volume", "host", "virtual_machine", "volume_group" ], | |
| "x-display_enum_text" : { | |
| "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" | |
| } | |
| }, | |
| "VolumeImportableCriteriaEnum" : { | |
| "type" : "string", | |
| "description" : "Volume import criteria. Values are:\n * Ready - The volume is ready for nondisruptive import.\n * Ready_For_Agentless_Import - The volume is ready for agentless import.\n * In_Progress - Import is in progress.\n * Host_Not_Added - The host or hosts accessing the volume have not been added to the appliance.\n * Imported - Import is complete.\n * Incompatible_Firmware - The software version on the source array is not compatible.\n * Incompatible_Host_Agent - The agent version on the host is not compatible.\n * Undetermined - The import status cannot be determined due to an internal error. Contact technical support.\n * Host_Volume_Offline - The host volume is offline.\n * 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.\n * Undetermined_Cluster_Type - The system cannot determine the host cluster type.\n * Source_Volume_Offline - The source volume is offline.\n * Replication_Destination - The volume is a replication destination.\n * SC_Live_Volume - The volume is a Storage Center Live Volume.\n * SC_Degraded - The volume is not available or is in a degraded state.\n * SC_Not_Active - The Storage Center volume is not an active volume.\n * Used_By_NAS - The volume is in use by NAS.\n * SC_Portable_Volume - The Storage Center volume is a destination of a portable volume.\n * VNX_Faulted - The VNX volume is in a faulted state.\n * VNX_Not_Ready - The VNX volume is not in a ready state.\n * VNX_Internal_Volume - The VNX volume is an internal volume.\n * Unity_System_Health_Inappropriate - The health of the Unity system is not suitable for import.\n * Unity_Volume_Health_Inappropriate - The health of the Unity volume is not suitable for import. \n * XtremIO_Severity_Inappropriate - The severity level of the XtremIO system is not suitable for import.\n * XtremIO_State_Inappropriate - The state of the XtremIO system is not suitable for import.\n * XtremIO_Volume_Severity_Inappropriate - The severity level XtremIO volume is not suitable for import.\n * XtremIO_Volume_State_Inappropriate - The state of the XtremIO volume is not suitable for import.", | |
| "enum" : [ "Ready", "In_Progress", "Host_Not_Added", "Imported", "Incompatible_Firmware", "Incompatible_Host_Agent", "Undetermined", "Host_Volume_Offline", "Cluster_Node_Count_MisMatch", "Undetermined_Cluster_Type", "Source_Volume_Offline", "Replication_Destination", "SC_Live_Volume", "SC_Degraded", "SC_Not_Active", "Used_By_NAS", "SC_Portable_Volume", "VNX_Faulted", "VNX_Not_Ready", "VNX_Internal_Volume", "Unity_System_Health_Inappropriate", "Unity_Volume_Health_Inappropriate" ], | |
| "x-display_enum_text" : { | |
| "Ready" : "Ready for import.", | |
| "In_Progress" : "Import is in progress.", | |
| "Host_Not_Added" : "The host or hosts have not been added.", | |
| "Imported" : "Import has completed.", | |
| "Incompatible_Firmware" : "Software version on the source array is not compatible.", | |
| "Incompatible_Host_Agent" : "Agent version on the host is not compatible.", | |
| "Undetermined" : "Import status cannot be determined due to an internal error. Contact\n technical support.", | |
| "Host_Volume_Offline" : "Host volume is offline.", | |
| "Cluster_Node_Count_MisMatch" : "All hosts have not been added.", | |
| "Undetermined_Cluster_Type" : "System cannot determine cluster type.", | |
| "Source_Volume_Offline" : "Source volume is offline.", | |
| "Replication_Destination" : "Replication destination.", | |
| "SC_Live_Volume" : "SC live volume.", | |
| "SC_Degraded" : "Volume is either not up or in degraded state.", | |
| "SC_Not_Active" : "Not an active volume.", | |
| "Used_By_NAS" : "Volume is in use by NAS.", | |
| "SC_Portable_Volume" : "Volume is a destination of a portable volume.", | |
| "VNX_Faulted" : "VNX volume is in faulted state.", | |
| "VNX_Not_Ready" : "VNX volume is not in ready state.", | |
| "VNX_Internal_Volume" : "VNX volume is an internal volume.", | |
| "Unity_System_Health_Inappropriate" : "Unity system health is not suitable for import.", | |
| "Unity_Volume_Health_Inappropriate" : "Unity volume health is not suitable for import." | |
| } | |
| }, | |
| "CGImportableCriteriaEnum" : { | |
| "type" : "string", | |
| "description" : "Consistency group import criteria. Values are:\n * Ready - The consistency group is ready for nondisruptive import.\n * Ready_For_Agentless_Import - The consistency group is ready for agentless import.\n * In_Progress - Import is in progress.\n * Members_Not_Ready - The member or members of teh consistency group are not ready for import.\n * No_Members - There are no members in the consistency group.\n * Max_Members - The maximum number of members for a consistency group has been exceeded.\n * Not_In_Sync - The array must be refreshed.\n * Imported - Import is complete.\n * Incompatible_Firmware - The software version on the source array is not compatible.\n * Undetermined - The import status cannot be determined due to an internal error. Contact technical support.", | |
| "enum" : [ "Ready", "In_Progress", "Members_Not_Ready", "No_Members", "Max_Members", "Not_In_Sync", "Imported", "Incompatible_Firmware", "Undetermined" ], | |
| "x-display_enum_text" : { | |
| "Ready" : "Ready for import.", | |
| "In_Progress" : "Import is in progress.", | |
| "Members_Not_Ready" : "Member(s) of Consistency Group are not ready for import.", | |
| "No_Members" : "No members in consistency group.", | |
| "Max_Members" : "Exceeded maximum members for a consistency group.", | |
| "Not_In_Sync" : "Refresh of array is required.", | |
| "Imported" : "Import has completed.", | |
| "Incompatible_Firmware" : "Software version on the source array is not compatible.", | |
| "Undetermined" : "Import status cannot be determined due to an internal error. Contact technical support." | |
| } | |
| }, | |
| "import_unity_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "management_address", "model", "health" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the Unity storage system that is a source storage system for import. This is the serial number of the storage system." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the Unity storage system. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "management_address" : { | |
| "type" : "string", | |
| "description" : "Management address to use for communicating with the Unity storage system. The address can be an IPv4 address, IPv6 address, or FQDN (Fully Qualified Domain Name).", | |
| "format" : "ip-address" | |
| }, | |
| "model" : { | |
| "type" : "string", | |
| "description" : "Model name of the Unity storage system." | |
| }, | |
| "software_version" : { | |
| "type" : "string", | |
| "description" : "Software version of the Unity storage system." | |
| }, | |
| "api_version" : { | |
| "type" : "string", | |
| "description" : "Version of the API that the Unity storage system supports." | |
| }, | |
| "health" : { | |
| "$ref" : "#/definitions/UnityHealthEnum" | |
| }, | |
| "user_name" : { | |
| "type" : "string", | |
| "description" : "User account name used to communicate with the Unity storage system." | |
| }, | |
| "serial_number" : { | |
| "type" : "string", | |
| "description" : "Serial number of the system" | |
| }, | |
| "last_updated_timestamp" : { | |
| "type" : "string", | |
| "description" : "Date and time when the Unity storage system details were last updated. These details include the Unity storage system and information about its importable volumes and consistency groups. The timestamp is updated when the Unity storage system is created and whenever the importable volumes and consistency groups are discovered.", | |
| "format" : "date-time" | |
| }, | |
| "health_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to health" | |
| }, | |
| "import_unity_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_unity_volume_instance", | |
| "x-ref" : "import_unity_volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type import_unity_volume association." | |
| }, | |
| "import_unity_consistency_groups" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_unity_consistency_group_instance", | |
| "x-ref" : "import_unity_consistency_group_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type import_unity_consistency_group association." | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from import_unity_volume, import_unity_consistency_group" | |
| }, | |
| "import_unity_volume_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "wwn", "name", "size", "import_unity.name", "import_unity_consistency_group.name", "health", "migration_state" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the Unity volume." | |
| }, | |
| "wwn" : { | |
| "type" : "string", | |
| "description" : "World Wide Name (WWN) of the Unity volume." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the Unity volume. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "size" : { | |
| "type" : "integer", | |
| "description" : "Size of the Unity volume, in bytes.", | |
| "format" : "int64", | |
| "x-units" : "bytes", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "import_unity_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the Unity storage system to which the Unity volume belongs." | |
| }, | |
| "import_unity_consistency_group_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the consistency group to which the Unity volume belongs. This value is null if the volume does not belong to a consistency group." | |
| }, | |
| "health" : { | |
| "$ref" : "#/definitions/UnityHealthEnum" | |
| }, | |
| "type" : { | |
| "$ref" : "#/definitions/UnityVolumeTypeEnum" | |
| }, | |
| "migration_state" : { | |
| "$ref" : "#/definitions/UnityVolumeMigrationStateEnum" | |
| }, | |
| "is_replication_destination" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the Unity volume is a replication destination." | |
| }, | |
| "is_thin_clone" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the Unity volume is a thin clone. " | |
| }, | |
| "importable_criteria" : { | |
| "description" : "Volume import criteria. If the value is not Ready, the volume is not importable and the value specifies the reason it is not importable.", | |
| "$ref" : "#/definitions/VolumeImportableCriteriaEnum" | |
| }, | |
| "host_volume_ids" : { | |
| "description" : "List of host volume identifiers that correspond to Unity volumes.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "health_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to health" | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "migration_state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to migration_state" | |
| }, | |
| "importable_criteria_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to importable_criteria" | |
| }, | |
| "import_unity" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/import_unity_instance", | |
| "description" : "This is the embeddable reference form of import_unity_id attribute.", | |
| "x-ref" : "import_unity" | |
| }, | |
| "import_unity_consistency_group" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/import_unity_consistency_group_instance", | |
| "description" : "This is the embeddable reference form of import_unity_consistency_group_id attribute.", | |
| "x-ref" : "import_unity_consistency_group" | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from import_unity, import_unity_consistency_group" | |
| }, | |
| "import_unity_consistency_group_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "import_unity_id", "import_unity.name" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the Unity consistency group." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the consistency group. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "import_unity_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the Unity storage system where the consistency group resides." | |
| }, | |
| "importable_criteria" : { | |
| "description" : "Consistency group import criteria.", | |
| "$ref" : "#/definitions/CGImportableCriteriaEnum" | |
| }, | |
| "importable_criteria_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to importable_criteria" | |
| }, | |
| "import_unity_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_unity_volume_instance", | |
| "x-ref" : "import_unity_volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type import_unity_volume association." | |
| }, | |
| "import_unity" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/import_unity_instance", | |
| "description" : "This is the embeddable reference form of import_unity_id attribute.", | |
| "x-ref" : "import_unity" | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from import_unity_volume, import_unity" | |
| }, | |
| "import_unity_snapshot_schedule_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "rules" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the Unity snapshot schedule." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the Unity snapshot schedule." | |
| }, | |
| "rules" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_unity_snapshot_schedule_rule_instance" | |
| } | |
| }, | |
| "is_default" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the Unity snapshot schedule is the default snapshot schedule." | |
| }, | |
| "is_modified" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the Unity snapshot schedule has been modified." | |
| }, | |
| "version" : { | |
| "$ref" : "#/definitions/UnityScheduleVersionEnum", | |
| "description" : "Version of the snapshot schedule." | |
| }, | |
| "version_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to version" | |
| } | |
| } | |
| }, | |
| "import_unity_snapshot_schedule_rule_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "type" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the snapshot schedule rule ." | |
| }, | |
| "type" : { | |
| "$ref" : "#/definitions/UnityScheduleTypeEnum", | |
| "description" : "Type of the snapshot schedule rule." | |
| }, | |
| "minute" : { | |
| "type" : "integer", | |
| "description" : "Snapshot schedule frequency.[0..59].", | |
| "minimum" : 0, | |
| "maximum" : 59, | |
| "format" : "int32" | |
| }, | |
| "hours" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "integer", | |
| "minimum" : 0, | |
| "maximum" : 23 | |
| }, | |
| "description" : "Hourly frequency for the snapshot schedule rule.[0..23]." | |
| }, | |
| "days_of_week" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/UnityDayofWeekEnum" | |
| }, | |
| "description" : "Days of the week for which the snapshot schedule rule applies." | |
| }, | |
| "days_of_month" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "integer", | |
| "minimum" : 1, | |
| "maximum" : 31 | |
| }, | |
| "description" : "Days of the month for which the snapshot schedule rule applies. [1..31]." | |
| }, | |
| "interval" : { | |
| "type" : "integer", | |
| "description" : "Number of days or hours between snaps, depending on the rule type. [1..31].", | |
| "minimum" : 1, | |
| "maximum" : 31, | |
| "format" : "int32" | |
| }, | |
| "is_auto_delete" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the system can automatically delete the snapshot based on pool automatic-deletion thresholds." | |
| }, | |
| "retention_time" : { | |
| "type" : "integer", | |
| "description" : "(Applies when the value of the isAutoDelete attribute is false.) Period of time for which to keep the snapshot, in seconds.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "days_of_week_l10n" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "Localized message array corresponding to days_of_week" | |
| } | |
| } | |
| }, | |
| "import_unity_volume_import_snapshot_schedules_response" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_unity_snapshot_schedule_instance" | |
| } | |
| }, | |
| "import_unity_consistency_group_import_snapshot_schedules_response" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_unity_snapshot_schedule_instance" | |
| } | |
| }, | |
| "UnityHealthEnum" : { | |
| "description" : "Health status of the Unity storage system. Values are: \n * Unknown - The status of the system cannot be determined. \n * Ok - The system is operating normally. \n * Ok_But - The system is operating normally but there are potential issues. \n * Degraded - The system is working, but performance may not be optimum. \n * Minor - The system is working, but it has experienced one or more minor failures.\n * 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. \n * Critical - The system has failed and recovery may not be possible. This condition should be remedied immediately. \n * Non_Recoverable - The system has failed and recovery may not be possible. This condition should be remedied immediately.", | |
| "type" : "string", | |
| "enum" : [ "Unknown", "Ok", "Ok_But", "Degraded", "Minor", "Major", "Critical", "Non_Recoverable" ], | |
| "x-display_enum_text" : { | |
| "Unknown" : "Unknown", | |
| "Ok" : "Ok", | |
| "Ok_But" : "Ok (But)", | |
| "Degraded" : "Degraded", | |
| "Minor" : "Minor", | |
| "Major" : "Major", | |
| "Critical" : "Critical", | |
| "Non_Recoverable" : "Non recoverable" | |
| } | |
| }, | |
| "UnityVolumeMigrationStateEnum" : { | |
| "description" : "Migration state of the Unity volume. Values are: \n * Normal - The volume is not migrated. \n * Prepared - The volume is ready for migration. \n * Disabled_For_IO - Host I/O is disabled on the volume. \n * In_Progress - Volume migration is in progress. \n * Completed - The volume is migrated. \n * Aborted - Volume migration is cancelled. \n * Not_Applicable - Volume migration state is not applicable if the system only supports agentless import.\n * Unknown - The volume migration state is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "Normal", "Prepare_For_Migration", "Source_Disabled_For_IO", "Source_Migration_In_Progress", "Source_Migration_Completed", "Source_Migration_Aborted", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "Normal" : "Normal", | |
| "Prepare_For_Migration" : "Ready for migration", | |
| "Source_Disabled_For_IO" : "Source disabled for I/O", | |
| "Source_Migration_In_Progress" : "Source migration in progress", | |
| "Source_Migration_Completed" : "Source migration is complete", | |
| "Source_Migration_Aborted" : "Source migration is cancelled", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "UnityVolumeTypeEnum" : { | |
| "description" : "Type of the Unity volume. Values are: \n * Unknown - Volume type cannot be determined. \n * Generic_Storage - A volume that is associated with a consistency group. \n * Standalone - A volume that is not associated with a consistency group. \n * Vmware_iSCSI - A volume associated with a VMware VMFS datastore.", | |
| "type" : "string", | |
| "enum" : [ "Unknown", "Generic_Storage", "Standalone", "Vmware_iSCSI" ], | |
| "x-display_enum_text" : { | |
| "Unknown" : "Unknown", | |
| "Generic_Storage" : "Generic Storage", | |
| "Standalone" : "Standalone", | |
| "Vmware_iSCSI" : "VMware iSCSI" | |
| } | |
| }, | |
| "UnityDayofWeekEnum" : { | |
| "description" : "Days of the week. Values are: \n * Sunday - Sunday. \n * Monday - Monday. \n * Tuesday - Tuesday. \n * Wednesday - Wednesday. \n * Thursday - Thursday. \n * Friday - Friday. \n * Saturday - Saturday. \n * Unknown - The day of week cannot be determined.", | |
| "type" : "string", | |
| "enum" : [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "Sunday" : "Sunday", | |
| "Monday" : "Monday", | |
| "Tuesday" : "Tuesday", | |
| "Wednesday" : "Wednesday", | |
| "Thursday" : "Thursday", | |
| "Friday" : "Friday", | |
| "Saturday" : "Saturday", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "UnityScheduleTypeEnum" : { | |
| "description" : "Snapshot schedule types. Values are:\n * N_Hours_At_MM - Create a snapshot every {interval} hours, at {minutes} past the hour. Supported parameters: interval (required), minutes (optional, default 0).\n * Day_At_HHMM - Specify a list of {hour[,...]} when to create a snapshot each day at {minutes} past the hour. Supported parameters: hours (at least one required), minutes (optional).\n * N_Days_At_HHMM - Create a snapshot every {interval} days at the time {hours}:{minutes}. Supported Parameters: interval (required), hours (optional, exactly one), minutes (optional).\n * SelDays_At_HHMM - Create a snapshot on the selected {daysOfWeek}, at the time {hours}:{minutes}. Supported parameters: daysOfWeek (at least one required), hours (optional, default 0), minutes (optional, default 0)\n * 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).\n * Unsupported - Unsupported. \n * Unknown - Schedule type is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "N_Hours_At_MM", "Day_At_HHMM", "N_Days_At_HHMM", "SelDays_At_HHMM", "Nth_Day_Of_Month_AT_HHMM", "Unsupported", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "N_Hours_At_MM" : "N hours st MM", | |
| "Day_At_HHMM" : "Day st HHMM", | |
| "N_Days_At_HHMM" : "N days at HHMM", | |
| "SelDays_At_HHMM" : "Selected days at HHMM", | |
| "Nth_Day_Of_Month_AT_HHMM" : "Nth day of the month at HHMM", | |
| "Unsupported" : "Unsupported", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "UnityScheduleVersionEnum" : { | |
| "description" : "Type of snapshot schedule. Values are: \n * Legacy - Legacy schedule with more than two rules of type HoursList, DaysInterval or MonthDaysList. \n * Simple - Simple schedule with two rules or less of rule type HoursInterval or WeekDaysList. \n * Unknown - Schedule type cannot be determined.", | |
| "type" : "string", | |
| "enum" : [ "Legacy", "Simple", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "Legacy" : "Legacy", | |
| "Simple" : "Simple", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "import_psgroup_instance" : { | |
| "description" : "PS Group details.\r\nThis resource type has queriable association from import_psgroup_volume", | |
| "x-select_cli" : [ "id", "name", "management_address", "description" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the PS Group." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the PS Group. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "serial_number" : { | |
| "type" : "string", | |
| "description" : "Serial number of the PS Group." | |
| }, | |
| "management_address" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "description" : "Management address of the PS Group. This can be an IPv4 address, IPv6 address, or FQDN (Fully Qualified Domain Name)." | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "Description of the PS Group." | |
| }, | |
| "user_name" : { | |
| "type" : "string", | |
| "description" : "Name used to log in to the PS Group." | |
| }, | |
| "group_address" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "description" : "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 operations." | |
| }, | |
| "last_update_time" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Time when the PS Group was last updated." | |
| }, | |
| "import_psgroup_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_psgroup_volume_instance", | |
| "x-ref" : "import_psgroup_volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type import_psgroup_volume association." | |
| } | |
| } | |
| }, | |
| "import_psgroup_volume_instance" : { | |
| "description" : "PS Group volume instance details.\r\nThis resource type has queriable association from import_psgroup", | |
| "x-select_cli" : [ "id", "is_online", "name", "size", "wwn", "migration_state", "import_psgroup.name" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the volume." | |
| }, | |
| "is_online" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the volume is online." | |
| }, | |
| "import_psgroup_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the PS Group with which the volume is associated." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the volume. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "size" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "description" : "Size of the volume, in bytes.", | |
| "x-units" : "bytes", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "block_size" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/VolumeBlockSizeEnum" | |
| }, | |
| "wwn" : { | |
| "type" : "string", | |
| "description" : "Unique WWN of the volume." | |
| }, | |
| "is_read_only" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the volume is read-only." | |
| }, | |
| "migration_state" : { | |
| "$ref" : "#/definitions/ImportStatusEnum" | |
| }, | |
| "importable_criteria" : { | |
| "type" : "string", | |
| "description" : "Volume import criteria. If the value is not Ready, the volume is not importable. ", | |
| "$ref" : "#/definitions/VolumeImportableCriteriaEnum" | |
| }, | |
| "host_volume_ids" : { | |
| "type" : "array", | |
| "description" : "Unique identifiers of the host volumes associated with the volume.", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "block_size_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to block_size" | |
| }, | |
| "migration_state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to migration_state" | |
| }, | |
| "importable_criteria_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to importable_criteria" | |
| }, | |
| "import_psgroup" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/import_psgroup_instance", | |
| "description" : "This is the embeddable reference form of import_psgroup_id attribute.", | |
| "x-ref" : "import_psgroup" | |
| } | |
| } | |
| }, | |
| "VolumeBlockSizeEnum" : { | |
| "description" : "Block size of the volume. Valid values are:\n * 512_Bytes - 512 byte block size.\n * 4K_Bytes - 4096 byte block size.\n * Unknown - Block size cannot be determined.", | |
| "type" : "string", | |
| "enum" : [ "512_Bytes", "4K_Bytes", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "512_Bytes" : "512 Bytes", | |
| "4K_Bytes" : "4K Bytes", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "ImportStatusEnum" : { | |
| "description" : "Migration state of the volume. Valid values are:\n * None - Volume is not migrated.\n * Normal - Volume state is normal.\n * Prepared - Volume is prepared for migration.\n * Disabled_For_IO - Volume is disabled for IO from host.\n * In_Progress - Volume migration is in progress.\n * Completed - Volume is migrated.\n * Aborted - Volume migration is aborted\n * Unknown - Volume migration state is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "None", "Normal", "Prepared", "Disabled_For_IO", "In_Progress", "Aborted", "Completed", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "None" : "None", | |
| "Normal" : "Normal", | |
| "Prepared" : "Prepared", | |
| "Disabled_For_IO" : "Disabled For IO", | |
| "In_Progress" : "In Progress", | |
| "Completed" : "Completed", | |
| "Aborted" : "Aborted", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "import_psgroup_volume_import_snapshot_schedules_response" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_psgroup_schedule_instance" | |
| } | |
| }, | |
| "import_psgroup_schedule_instance" : { | |
| "description" : "Snapshot schedule of a volume", | |
| "x-select_cli" : [ "name", "type", "status" ], | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the snapshot schedule." | |
| }, | |
| "type" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/ImportPsgroupScheduleTypeEnum" | |
| }, | |
| "active_date" : { | |
| "type" : "integer", | |
| "description" : "Number of days for which the snapshot schedule has been active.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "inactive_date" : { | |
| "type" : "integer", | |
| "description" : "Number of days for which the snapshot schedule has been inactive.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "repetition_interval" : { | |
| "type" : "integer", | |
| "description" : "Repeat interval of the snapshot schedule, in days. The value is 1 for the schedule frequencies Once and Hourly. It can be greater than 1 for the schedule frequencies Daily and Weekly.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "start_time" : { | |
| "type" : "integer", | |
| "description" : "Time when snapshot creation begins each day, in minutes.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "end_time" : { | |
| "type" : "integer", | |
| "description" : "Time when snapshot creation ends each day, in minutes.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "frequency" : { | |
| "type" : "integer", | |
| "description" : "Frequency at which snapshots are created, in minutes.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "status" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/ImportPsgroupScheduleStatusEnum" | |
| }, | |
| "keep_count" : { | |
| "type" : "integer", | |
| "format" : "int32", | |
| "description" : "Number of snapshots to retain.", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "status_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to status" | |
| } | |
| } | |
| }, | |
| "ImportPsgroupScheduleStatusEnum" : { | |
| "description" : "Snapshot schedule status. Valid values are:\n * Enabled - Snapshot schedule is enabled.\n * Disabled - Snapshot schedule is disabled.\n * Expired - Snapshot schedule is expired.", | |
| "type" : "string", | |
| "enum" : [ "Enabled", "Disabled", "Expired" ], | |
| "x-display_enum_text" : { | |
| "Enabled" : "Enabled", | |
| "Disabled" : "Disabled", | |
| "Expired" : "Expired" | |
| } | |
| }, | |
| "ImportPsgroupScheduleTypeEnum" : { | |
| "description" : "Snapshot schedule frequency. Valid values are:\n * Once - Take snapshot only once.\n * Hourly - Take snapshot hourly.\n * Daily - Take snapshot on a daily basis.\n * Weekly - Take snapshot on a weekly basis.\n * Monthly - Take snapshot on a monthly basis.", | |
| "type" : "string", | |
| "enum" : [ "Once", "Hourly", "Daily", "Weekly", "Monthly" ], | |
| "x-display_enum_text" : { | |
| "Once" : "Once", | |
| "Hourly" : "Hourly", | |
| "Daily" : "Daily", | |
| "Weekly" : "Weekly", | |
| "Monthly" : "Monthly" | |
| } | |
| }, | |
| "import_storage_center_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "management_address", "model", "status", "import_storage_center_consistency_groups.name" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the SC array that is a source storage system for import." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the SC array. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "management_address" : { | |
| "type" : "string", | |
| "description" : "Management address to use for communicating with the SC array. The address can be an IPv4 address, IPv6 address, or FQDN (Fully Qualified Domain Name).", | |
| "format" : "ip-address" | |
| }, | |
| "user_name" : { | |
| "type" : "string", | |
| "description" : "User account name used to communicate with the SC array." | |
| }, | |
| "model" : { | |
| "type" : "string", | |
| "description" : "Model name of the SC array." | |
| }, | |
| "serial_number" : { | |
| "type" : "integer", | |
| "description" : "Serial number of the SC array.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "api_version" : { | |
| "type" : "string", | |
| "description" : "API version of the SC OS (SCOS)." | |
| }, | |
| "status" : { | |
| "$ref" : "#/definitions/SCStatusEnum" | |
| }, | |
| "last_update_time" : { | |
| "type" : "string", | |
| "description" : "Timestamp at which the SC array details were last updated. This includes the information about the array and its importable volumes and consistency groups. The timestamp is updated when the SC array is created and when the importable storage resources are discovered using the discover_importable_resources action.", | |
| "format" : "date-time" | |
| }, | |
| "status_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to status" | |
| }, | |
| "import_storage_center_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_storage_center_volume_instance", | |
| "x-ref" : "import_storage_center_volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type import_storage_center_volume association." | |
| }, | |
| "import_storage_center_consistency_groups" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_storage_center_consistency_group_instance", | |
| "x-ref" : "import_storage_center_consistency_group_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type import_storage_center_consistency_group association." | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from import_storage_center_volume, import_storage_center_consistency_group" | |
| }, | |
| "SCStatusEnum" : { | |
| "description" : "Status of an SC array. Valid values are:\n * Up - Volume state is up.\n * Down - Volume state is down.\n * Degraded - Volume is in degraded state.\n * Unknown - Volume migration state is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "Up", "Down", "Degraded", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "Up" : "Up", | |
| "Down" : "Down", | |
| "Degraded" : "Degraded", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "import_storage_center_volume_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "size", "wwn", "health", "import_storage_center.name" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the SC volume." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the SC volume. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "size" : { | |
| "type" : "integer", | |
| "description" : "Size of the SC volume, in bytes.", | |
| "format" : "int64", | |
| "x-units" : "bytes", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "wwn" : { | |
| "type" : "string", | |
| "description" : "Device identifier presented to the server to which the volume is mapped." | |
| }, | |
| "health" : { | |
| "$ref" : "#/definitions/SCStatusEnum" | |
| }, | |
| "is_active" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the SC volume is active on any controller. Only volumes that are active are importable." | |
| }, | |
| "import_storage_center_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the SC array where the volume resides." | |
| }, | |
| "migration_state" : { | |
| "$ref" : "#/definitions/MigrationStateEnum" | |
| }, | |
| "is_read_only" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the volume is read-only." | |
| }, | |
| "importable_criteria" : { | |
| "type" : "string", | |
| "description" : "Volume import criteria. If the value is not Ready, the volume is not importable.", | |
| "$ref" : "#/definitions/VolumeImportableCriteriaEnum" | |
| }, | |
| "host_volume_ids" : { | |
| "description" : "List of host volume identifiers that correspond to SC volumes.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "import_storage_center_consistency_group_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of an SC consistency group, if the volume is part of one consistency group only. If the volume is part of multiple consistency groups, the attribute is empty." | |
| }, | |
| "import_storage_center_consistency_group_names" : { | |
| "type" : "array", | |
| "description" : "Names of the consistency groups of which the volume is a member, if this volume is in multiple consistency groups.", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "health_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to health" | |
| }, | |
| "migration_state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to migration_state" | |
| }, | |
| "importable_criteria_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to importable_criteria" | |
| }, | |
| "import_storage_center" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/import_storage_center_instance", | |
| "description" : "This is the embeddable reference form of import_storage_center_id attribute.", | |
| "x-ref" : "import_storage_center" | |
| }, | |
| "import_storage_center_consistency_group" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/import_storage_center_consistency_group_instance", | |
| "description" : "This is the embeddable reference form of import_storage_center_consistency_group_id attribute.", | |
| "x-ref" : "import_storage_center_consistency_group" | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from import_storage_center, import_storage_center_consistency_group" | |
| }, | |
| "MigrationStateEnum" : { | |
| "description" : "Migration status of a volume. Valid values are:\n * Legacy - Volume state is normal.\n * Preparing - Volume is prepared for migration.\n * Disabled_For_IO - Volume is disabled for IO from host.\n * In_Progress - Volume migration is in progress.\n * Done- Volume is migrated.\n * Aborted - Volume migration is aborted\n * Not_Applicable - Volume migration state is not applicable when storage system supports only\n agentless import\n * Unknown - Volume migration state is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "Legacy", "Preparing", "Disabled_For_IO", "In_Progress", "Done", "Aborted", "Not_Applicable", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "Legacy" : "Legacy", | |
| "Preparing" : "Preparing", | |
| "Disabled_For_IO" : "Disabled For IO", | |
| "In_Progress" : "In Progress", | |
| "Done" : "Done", | |
| "Aborted" : "Aborted", | |
| "Not_Applicable" : "Not Applicable", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "import_storage_center_consistency_group_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "import_storage_center_id", "import_storage_center.name" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the SC consistency group." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the SC consistency group. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "import_storage_center_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the SC array." | |
| }, | |
| "importable_criteria" : { | |
| "type" : "string", | |
| "description" : "Volume import criteria. If the value is not Ready, the volume is not importable.", | |
| "$ref" : "#/definitions/CGImportableCriteriaEnum" | |
| }, | |
| "importable_criteria_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to importable_criteria" | |
| }, | |
| "import_storage_center_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_storage_center_volume_instance", | |
| "x-ref" : "import_storage_center_volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type import_storage_center_volume association." | |
| }, | |
| "import_storage_center" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/import_storage_center_instance", | |
| "description" : "This is the embeddable reference form of import_storage_center_id attribute.", | |
| "x-ref" : "import_storage_center" | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from import_storage_center_volume, import_storage_center" | |
| }, | |
| "import_storage_center_snapshot_profile_instance" : { | |
| "title" : "sc_snapshot_profile", | |
| "description" : "Snapshot profile.", | |
| "x-select_cli" : [ "id", "name", "rules" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the snapshot profile." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the snapshot profile." | |
| }, | |
| "type" : { | |
| "type" : "string", | |
| "description" : "Type of the snapshot profile.", | |
| "$ref" : "#/definitions/ScSnapshotProfileTypeEnum" | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "Description of the snapshot profile." | |
| }, | |
| "rules" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/sc_profile_rule_instance" | |
| } | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| } | |
| } | |
| }, | |
| "import_storage_center_volume_import_snapshot_profiles_response" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_storage_center_snapshot_profile_instance" | |
| } | |
| }, | |
| "import_storage_center_consistency_group_import_snapshot_profiles_response" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_storage_center_snapshot_profile_instance" | |
| } | |
| }, | |
| "sc_profile_rule_instance" : { | |
| "type" : "object", | |
| "description" : "Snapshot profile rule.", | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the snapshot profile rule." | |
| }, | |
| "expiration" : { | |
| "type" : "integer", | |
| "description" : "Length of time to keep snapshots before deleting them, in minutes.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "frequency" : { | |
| "type" : "string", | |
| "description" : "Frequency at which the snapshot will be taken.", | |
| "$ref" : "#/definitions/ScScheduleTypeEnum" | |
| }, | |
| "start_date_time" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Date and time when the snapshot will be created. This applies to the value Once in the ScScheduleTypeEnum." | |
| }, | |
| "start_time" : { | |
| "type" : "string", | |
| "format" : "timestamp", | |
| "description" : "Time when snapshot creation will start." | |
| }, | |
| "end_time" : { | |
| "type" : "string", | |
| "format" : "timestamp", | |
| "description" : "Time when snapshot creation will stop." | |
| }, | |
| "interval" : { | |
| "type" : "integer", | |
| "description" : "Time interval between any two snapshot creations, in minutes.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "month_of_year" : { | |
| "type" : "array", | |
| "description" : "Months of the year in which a snapshot will be taken.", | |
| "items" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/MonthOfYearEnum" | |
| } | |
| }, | |
| "week_of_month" : { | |
| "type" : "array", | |
| "description" : "Weeks of the month in which a snapshot will be taken.", | |
| "items" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/WeekOfMonthEnum" | |
| } | |
| }, | |
| "day_of_week" : { | |
| "type" : "array", | |
| "description" : "Days of the week in which a snapshot will be taken.", | |
| "items" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/DayOfWeekEnum" | |
| } | |
| }, | |
| "date_of_month" : { | |
| "type" : "array", | |
| "description" : "Dates of the month in which a snapshot will be taken.", | |
| "items" : { | |
| "type" : "integer" | |
| } | |
| }, | |
| "frequency_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to frequency" | |
| }, | |
| "month_of_year_l10n" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "Localized message array corresponding to month_of_year" | |
| }, | |
| "week_of_month_l10n" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "Localized message array corresponding to week_of_month" | |
| }, | |
| "day_of_week_l10n" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "Localized message array corresponding to day_of_week" | |
| } | |
| } | |
| }, | |
| "ScSnapshotProfileTypeEnum" : { | |
| "description" : "Available SC snapshot profile types. Valid values are:\n * Standard - Takes snapshots in series for all volumes associated with the snapshot.\n * Parallel - Takes snapshots simultaneously for all volumes associated with the snapshot.\n * Consistent - Halts IO and takes snapshots for all volumes associated with the snapshot.\n * Unknown - SC snapshot profile type is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "Standard", "Parallel", "Consistent", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "Standard" : "Standard", | |
| "Parallel" : "Parallel", | |
| "Consistent" : "Consistent", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "ScScheduleTypeEnum" : { | |
| "description" : "Available SC snapshot schedule types. Valid values are:\n * Once - Take snapshot only once.\n * Daily- Take snapshot hourly.\n * Weekly - Take snapshot on a weekly basis.\n * Monthly - Take snapshot on a monthly basis.\n * Unknown - SC schedule type is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "Once", "Daily", "Weekly", "Monthly", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "Once" : "Once", | |
| "Daily" : "Daily", | |
| "Weekly" : "Weekly", | |
| "Monthly" : "Monthly", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "MonthOfYearEnum" : { | |
| "description" : "Months of the year. Valid values are:\n * January - January \n * February - February \n * March - March \n * April - April \n * May - May \n * June - June \n * July - July \n * August - August \n * September - September \n * October - October \n * November - November \n * December - December \n * Unknown - Month of year is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "January" : "January", | |
| "February" : "February", | |
| "March" : "March", | |
| "April" : "April", | |
| "May" : "May", | |
| "June" : "June", | |
| "July" : "July", | |
| "August" : "August", | |
| "September" : "September", | |
| "October" : "October", | |
| "November" : "November", | |
| "December" : "December", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "WeekOfMonthEnum" : { | |
| "description" : "Weeks of the month. Valid values are:\n * First - First week of the month \n * Second - Second week of the month \n * Third - Third week of the month \n * Fourth - Fourth week of the month \n * Last - Last week of the month \n * Unknown - Week of month is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "First", "Second", "Third", "Fourth", "Last", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "First" : "First", | |
| "Second" : "Second", | |
| "Third" : "Third", | |
| "Fourth" : "Fourth", | |
| "Last" : "Last", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "DayOfWeekEnum" : { | |
| "description" : "Days of the week. Valid values are:\n * Monday - Monday \n * Tuesday - Tuesday \n * Wednesday - Wednesday \n * Thursday - Thursday \n * Friday - Friday \n * Saturday - Saturday \n * Sunday - Sunday \n * Unknown - Day of week is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "Monday" : "Monday", | |
| "Tuesday" : "Tuesday", | |
| "Wednesday" : "Wednesday", | |
| "Thursday" : "Thursday", | |
| "Friday" : "Friday", | |
| "Saturday" : "Saturday", | |
| "Sunday" : "Sunday", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "import_vnx_array_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "management_address", "model", "is_faulted", "last_updated_timestamp" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the VNX storage system." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the VNX storage system. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "serial_number" : { | |
| "type" : "string", | |
| "description" : "Serial number of the VNX storage system." | |
| }, | |
| "management_address" : { | |
| "type" : "string", | |
| "description" : "Management address for communicating with the VNX storage system. This is usually the address of Storage Processor A (SPA). The address can be an IPv4 address, IPv6 address, or FQDN (Fully Qualified Domain Name).", | |
| "format" : "ip-address" | |
| }, | |
| "alternate_management_address" : { | |
| "type" : "string", | |
| "description" : "Alternate management address for communicating with the VNX storage system. This is usually the address of Storage Processor B (SPB). The address can be an IPv4 address, IPv6 address, or FQDN (Fully Qualified Domain Name).", | |
| "format" : "ip-address" | |
| }, | |
| "user_name" : { | |
| "type" : "string", | |
| "description" : "User account name used to communicate with the VNX storage system." | |
| }, | |
| "model" : { | |
| "type" : "string", | |
| "description" : "Model name of the VNX storage system." | |
| }, | |
| "is_faulted" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the VNX storage system is faulted." | |
| }, | |
| "last_updated_timestamp" : { | |
| "type" : "string", | |
| "description" : "Timestamp at which the VNX storage system details were last updated. These details include information about the VNX storage system and its importable volumes and consistency groups. The timestamp is updated when the VNX storage system is created and when the importable storage resources are discovered using the discover action.", | |
| "format" : "date-time" | |
| }, | |
| "software_version" : { | |
| "type" : "string", | |
| "description" : "The software version of the block operating environment of the VNX storage system." | |
| }, | |
| "import_vnx_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_vnx_volume_instance", | |
| "x-ref" : "import_vnx_volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type import_vnx_volume association." | |
| }, | |
| "import_vnx_consistency_groups" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_vnx_consistency_group_instance", | |
| "x-ref" : "import_vnx_consistency_group_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type import_vnx_consistency_group association." | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from import_vnx_volume, import_vnx_consistency_group" | |
| }, | |
| "import_vnx_volume_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "wwn", "size", "health", "migration_state", "import_vnx_array_id", "import_vnx_array.name" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the VNX volume." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the VNX volume. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "wwn" : { | |
| "type" : "string", | |
| "description" : "World wide name of the VNX volume." | |
| }, | |
| "size" : { | |
| "type" : "integer", | |
| "description" : "Size of the VNX volume in bytes.", | |
| "format" : "int64", | |
| "x-units" : "bytes", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "health" : { | |
| "$ref" : "#/definitions/VnxVolumeStateEnum" | |
| }, | |
| "migration_state" : { | |
| "$ref" : "#/definitions/VnxVolumeMigrationStateEnum" | |
| }, | |
| "import_vnx_array_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the VNX storage system where the volume exists." | |
| }, | |
| "import_vnx_consistency_group_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the VNX consistency group, if the volume is in a consistency group." | |
| }, | |
| "importable_criteria" : { | |
| "$ref" : "#/definitions/VolumeImportableCriteriaEnum" | |
| }, | |
| "host_volume_ids" : { | |
| "description" : "List of host volume identifiers associated with the VNX volume.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "health_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to health" | |
| }, | |
| "migration_state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to migration_state" | |
| }, | |
| "importable_criteria_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to importable_criteria" | |
| }, | |
| "import_vnx_array" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/import_vnx_array_instance", | |
| "description" : "This is the embeddable reference form of import_vnx_array_id attribute.", | |
| "x-ref" : "import_vnx_array" | |
| }, | |
| "import_vnx_consistency_group" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/import_vnx_consistency_group_instance", | |
| "description" : "This is the embeddable reference form of import_vnx_consistency_group_id attribute.", | |
| "x-ref" : "import_vnx_consistency_group" | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from import_vnx_array, import_vnx_consistency_group" | |
| }, | |
| "import_vnx_consistency_group_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "import_vnx_array.name" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the VNX consistency group." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the consistency group. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "import_vnx_array_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the VNX storage system where the consistency group exists." | |
| }, | |
| "importable_criteria" : { | |
| "$ref" : "#/definitions/CGImportableCriteriaEnum" | |
| }, | |
| "importable_criteria_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to importable_criteria" | |
| }, | |
| "import_vnx_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_vnx_volume_instance", | |
| "x-ref" : "import_vnx_volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type import_vnx_volume association." | |
| }, | |
| "import_vnx_array" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/import_vnx_array_instance", | |
| "description" : "This is the embeddable reference form of import_vnx_array_id attribute.", | |
| "x-ref" : "import_vnx_array" | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from import_vnx_volume, import_vnx_array" | |
| }, | |
| "VnxVolumeMigrationStateEnum" : { | |
| "description" : "Migration state of the VNX volume. Values are: * None - The volume is not migrated. * Prepared - The volume is ready for migration. * Disabled_For_IO - Host I/O is disabled on the volume. * In_Progress - Volume migration is in progress. * Completed - The volume is migrated. * 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 cannot be determined.", | |
| "type" : "string", | |
| "enum" : [ "None", "Prepared", "Disabled_For_IO", "In_Progress", "Completed", "Aborted", "Not_Applicable", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "None" : "None", | |
| "Prepared" : "Prepared", | |
| "Disabled_For_IO" : "Disabled For IO", | |
| "In_Progress" : "In Progress", | |
| "Completed" : "Completed", | |
| "Aborted" : "Aborted", | |
| "Not_Applicable" : "Not Applicable", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "VnxVolumeStateEnum" : { | |
| "description" : "State of the VNX volume. Only volumes that are in the Ready or Default state can be imported. If a volume is in any other state, the underlying cause of the state must be corrected with the VNX management software, and the VNX volume details must be refreshed using the refresh action to import the volume. Values are: * Invalid - The volume is in an invalid state. * Ready - The volume is ready. This is the healthy state of a storage pool based volume. * Faulted - The volume is faulted. * Offline - The volume is offline. * Destroying - The volume is being destroyed. * Default - The volume is ready. This is the healthy state of a RAID group based volume.", | |
| "type" : "string", | |
| "enum" : [ "Invalid", "Initializing", "Ready", "Faulted", "Offline", "Destroying", "Default" ], | |
| "x-display_enum_text" : { | |
| "Invalid" : "Invalid", | |
| "Initializing" : "Initializing", | |
| "Ready" : "Ready", | |
| "Faulted" : "Faulted", | |
| "Offline" : "Offline", | |
| "Destroying" : "Destroying", | |
| "Default" : "Default" | |
| } | |
| }, | |
| "import_host_system_instance" : { | |
| "description" : "Details about an import host system.\r\nThis resource type has queriable association from host", | |
| "x-select_cli" : [ "id", "agent_address", "os_type", "agent_status", "hosts.name" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the import host system." | |
| }, | |
| "agent_address" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "description" : "Hostname or IPv4 address of the import host system." | |
| }, | |
| "agent_type" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/HostAgentTypeEnum" | |
| }, | |
| "agent_port" : { | |
| "type" : "integer", | |
| "description" : "TCP port on the import host system.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "agent_version" : { | |
| "type" : "string", | |
| "description" : "Version of the import host system." | |
| }, | |
| "agent_api_version" : { | |
| "type" : "string", | |
| "description" : "API version of the import host system." | |
| }, | |
| "os_type" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/HAOSTypeEnum" | |
| }, | |
| "os_version" : { | |
| "type" : "string", | |
| "description" : "Operating system version of the import host system." | |
| }, | |
| "agent_status" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/HostAgentStatusEnum" | |
| }, | |
| "user_name" : { | |
| "type" : "string", | |
| "description" : "Username for the import host system." | |
| }, | |
| "last_update_time" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Time when the import host system was last updated." | |
| }, | |
| "agent_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to agent_type" | |
| }, | |
| "os_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to os_type" | |
| }, | |
| "agent_status_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to agent_status" | |
| }, | |
| "hosts" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_instance", | |
| "x-ref" : "host_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type host association." | |
| } | |
| } | |
| }, | |
| "HostAgentStatusEnum" : { | |
| "description" : "Status of the import host system. Valid values are:\n * Unknown - Agent status is unknown.\n * Running - Agent is up and running.\n * Conflict_Detected - Agent detected that there are multiple MPIOs installed on the host and Destination Powerstore MPIO is not able to claim destination device as some other MPIO has already claimed it.\n * Version_Unsupported - Agent detected that the OS or any other dependent component does not satisfy the version as expected by the it.", | |
| "type" : "string", | |
| "enum" : [ "Unknown", "Running", "Conflict_Detected", "Version_Unsupported" ], | |
| "x-display_enum_text" : { | |
| "Unknown" : "Unknown", | |
| "Running" : "Running", | |
| "Conflict_Detected" : "Conflict Detected", | |
| "Version_Unsupported" : "Version Unsupported" | |
| } | |
| }, | |
| "HAOSTypeEnum" : { | |
| "description" : "Operating system of the import host system. Valid values are:\n * Windows - Windows. \n * Linux - Linux. \n * ESXi - ESXi. \n * Unknown - Operating system of the host system is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "Windows", "Linux", "ESXi", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "Windows" : "Windows", | |
| "Linux" : "Linux", | |
| "ESXi" : "ESXi", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "HostAgentTypeEnum" : { | |
| "description" : "Type of import host system. Valid values are:\n * EQL - EQL MPIO. \n * Native_MPIO - Native MPIO. \n * Power_Path - POWER PATH MPIO. \n * Unknown - Type of host agent is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "EQL", "Native_MPIO", "Power_Path", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "EQL" : "EQL", | |
| "Native_MPIO" : "Native MPIO", | |
| "Power_Path" : "Power Path ", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "import_host_initiator_instance" : { | |
| "description" : "Details about an import host initiator.", | |
| "x-select_cli" : [ "id", "iqn_or_wwn", "protocol", "import_host_system_id" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the import host initiator." | |
| }, | |
| "iqn_or_wwn" : { | |
| "type" : "string", | |
| "description" : "iSCSI Qualified Name (IQN) or World Wide Name (WWN) of the host initiator." | |
| }, | |
| "protocol" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/HostInitiatorProtocolTypeEnum" | |
| }, | |
| "import_host_system_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the import host system." | |
| }, | |
| "protocol_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to protocol" | |
| } | |
| } | |
| }, | |
| "HostInitiatorProtocolTypeEnum" : { | |
| "description" : "Protocol type of the import host initiator. Valid values are:\n * Other - Protocol type is other. \n * iSCSI - Protocol type is internet SCSI. \n * FC - Protocol type is Fibre Channel. \n * FCoE - Protocol type is Fibre Channel over Ethernet. \n * Unknown - Protocol type is unknown to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "Other", "iSCSI", "FC", "FCoE", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "Other" : "Other", | |
| "iSCSI" : "iSCSI", | |
| "FC" : "FC", | |
| "FCoE" : "FCoE", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "ImportOperationStatusEnum" : { | |
| "description" : "Migration state of the import host volume. Valid values are:\n * Import_Completed - Import operation was successful. \n * Cancel_Completed - Cancel operation was successful. \n * Import_Aborted - Aborted the ongoing import. \n * Cancel_Aborted - Aborted the ongoing cancel operation. \n * Cancel_Forced - Aborted the ongoing cancel operation. \n * None - Migration state is not known to PowerStore.", | |
| "type" : "string", | |
| "enum" : [ "Import_Completed", "Cancel_Completed", "Import_Aborted", "Cancel_Aborted", "Cancel_Forced", "None" ], | |
| "x-display_enum_text" : { | |
| "Import_Completed" : "Import completed", | |
| "Cancel_Completed" : "Cancel completed", | |
| "Import_Aborted" : "Import aborted", | |
| "Cancel_Aborted" : "Cancel aborted", | |
| "Cancel_Forced" : "Forced cancelled", | |
| "None" : "None" | |
| } | |
| }, | |
| "import_host_volume_instance" : { | |
| "description" : "Details about an import host volume.", | |
| "x-select_cli" : [ "id", "name", "size", "status", "naa_id" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the import host volume." | |
| }, | |
| "host_system_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the import host system." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the import host volume. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "array_type" : { | |
| "description" : "Product type of the storage system.", | |
| "type" : "string", | |
| "$ref" : "#/definitions/ArrayTypeEnum" | |
| }, | |
| "array_identifier" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the storage system." | |
| }, | |
| "size" : { | |
| "type" : "integer", | |
| "description" : "Size of the import host volume, in bytes.", | |
| "format" : "int64", | |
| "x-units" : "bytes", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "status" : { | |
| "description" : "Status of the import host volume.", | |
| "$ref" : "#/definitions/VolumeStatusEnum" | |
| }, | |
| "is_migrating" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the import host volume is migrating." | |
| }, | |
| "active_path" : { | |
| "description" : "Active path of the host volume.", | |
| "$ref" : "#/definitions/ActivePathEnum" | |
| }, | |
| "protocols" : { | |
| "type" : "array", | |
| "description" : "Supported protocols for the import host volume.", | |
| "items" : { | |
| "$ref" : "#/definitions/HostInitiatorProtocolTypeEnum" | |
| } | |
| }, | |
| "mount_paths" : { | |
| "type" : "array", | |
| "description" : "Mount paths on the import host system.", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "import_state" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/ImportOperationStatusEnum" | |
| }, | |
| "naa_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of a volume that is presented to the import host." | |
| }, | |
| "last_update_time" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Time when the import host volume was last updated." | |
| }, | |
| "array_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to array_type" | |
| }, | |
| "status_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to status" | |
| }, | |
| "active_path_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to active_path" | |
| }, | |
| "protocols_l10n" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "Localized message array corresponding to protocols" | |
| }, | |
| "import_state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to import_state" | |
| } | |
| } | |
| }, | |
| "ArrayTypeEnum" : { | |
| "description" : "Product type of the storage system. Valid values are:\n * Unknown - Product type is unknown to PowerStore. \n * SC - Storage Center. \n * PS - Peer Storage Group. \n * VNX - VNX. \n * Unity - Unity.", | |
| "type" : "string", | |
| "enum" : [ "Unknown", "SC", "PS", "VNX", "Unity" ], | |
| "x-display_enum_text" : { | |
| "Unknown" : "Unknown", | |
| "SC" : "SC", | |
| "PS" : "PS", | |
| "VNX" : "VNX", | |
| "Unity" : "Unity" | |
| } | |
| }, | |
| "VolumeStatusEnum" : { | |
| "description" : "Status of the import host volume. Valid values are:\n * Unknown - Volume status is unknown. \n * Online - Volume is online. \n * Offline - Volume is offline.", | |
| "type" : "string", | |
| "enum" : [ "Unknown", "Online", "Offline" ], | |
| "x-display_enum_text" : { | |
| "Unknown" : "Unknown", | |
| "Online" : "Online", | |
| "Offline" : "Offline" | |
| } | |
| }, | |
| "ActivePathEnum" : { | |
| "description" : "Active path of the import host volume. Valid values are:\n * None - No active path available. \n * Source - Current IO path is set to source. \n * Destination - Current IO path is set to destination.", | |
| "type" : "string", | |
| "enum" : [ "None", "Source", "Destination" ], | |
| "x-display_enum_text" : { | |
| "None" : "None", | |
| "Source" : "Source", | |
| "Destination" : "Destination" | |
| } | |
| }, | |
| "import_host_system_create" : { | |
| "description" : "Required parameters for adding an import host system.", | |
| "required" : [ "agent_address", "user_name", "password", "os_type", "agent_port" ], | |
| "properties" : { | |
| "os_type" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/HAOSTypeEnum" | |
| }, | |
| "agent_address" : { | |
| "type" : "string", | |
| "description" : "Hostname or IPv4 address of the import host system." | |
| }, | |
| "agent_port" : { | |
| "type" : "integer", | |
| "description" : "TCP port of the import host system.", | |
| "minimum" : 0, | |
| "maximum" : 65535, | |
| "format" : "int32" | |
| }, | |
| "user_name" : { | |
| "type" : "string", | |
| "description" : "Username for the import host system." | |
| }, | |
| "password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "Password for the specified username." | |
| }, | |
| "chap_single_username" : { | |
| "type" : "string", | |
| "description" : "Username for single CHAP authentication. This username is required when the cluster is using single authentication CHAP mode." | |
| }, | |
| "chap_single_password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "Password for single CHAP authentication. This password is required when the cluster is using single authentication CHAP mode." | |
| }, | |
| "chap_mutual_username" : { | |
| "type" : "string", | |
| "description" : "Username for mutual CHAP authentication. This username is required when the cluster is using mutual authentication CHAP mode." | |
| }, | |
| "chap_mutual_password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "Password for mutual CHAP authentication. This password is required when the cluster is using mutual authentication CHAP mode." | |
| } | |
| } | |
| }, | |
| "virtual_volume_instance" : { | |
| "title" : "virtual_volume_instance", | |
| "description" : "A virtual volume.\r\nThis resource type has queriable associations from appliance, storage_container, migration_session, virtual_volume, host_virtual_volume_mapping", | |
| "x-select_cli" : [ "id", "size", "appliance_id", "storage_container.name" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "The unique identifier of the virtual volume.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "The name of the virtual volume, based on metadata provided by vSphere. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "size" : { | |
| "description" : "The size of the virtual volume in bytes.", | |
| "type" : "integer", | |
| "x-units" : "bytes", | |
| "format" : "int64", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "type" : { | |
| "$ref" : "#/definitions/VirtualVolumeTypeEnum" | |
| }, | |
| "usage_type" : { | |
| "$ref" : "#/definitions/VirtualVolumeUsageTypeEnum" | |
| }, | |
| "appliance_id" : { | |
| "description" : "The appliance where the virtual volume resides.", | |
| "type" : "string" | |
| }, | |
| "storage_container_id" : { | |
| "description" : "The storage container where the virtual volume resides.", | |
| "type" : "string" | |
| }, | |
| "io_priority" : { | |
| "$ref" : "#/definitions/IoPriorityEnum" | |
| }, | |
| "profile_id" : { | |
| "description" : "The ID of the storage profile governing this virtual volume.", | |
| "type" : "string" | |
| }, | |
| "creator_type" : { | |
| "$ref" : "#/definitions/StorageCreatorTypeEnum" | |
| }, | |
| "is_readonly" : { | |
| "description" : "Indicates whether the virtual volume is read-only.", | |
| "type" : "boolean" | |
| }, | |
| "migration_session_id" : { | |
| "description" : "If the virtual volume is part of a migration activity, the session ID for that migration.", | |
| "type" : "string" | |
| }, | |
| "virtual_machine_uuid" : { | |
| "description" : "UUID of the virtual machine that owns this virtual volume.", | |
| "type" : "string" | |
| }, | |
| "family_id" : { | |
| "description" : "Family id of the virtual volume. This is the id of the primary object at the root of the family tree. For a primary virtual volume this will be the same as the id of the object. For snap-sets and clone vVols it will be set to the source objects family ID.", | |
| "type" : "string" | |
| }, | |
| "parent_id" : { | |
| "description" : "For snapshots and clones, the ID of the parent virtual volume. The parent_id is set when an virtual volume is created and will only change if its parent virtual volume is deleted.", | |
| "type" : "string" | |
| }, | |
| "source_id" : { | |
| "description" : "Id of the virtual volume from which the content has been sourced. Data is sourced from another virtual volume when a snapshot or clone is created, or when a refresh or restore occurs. Only applies to snap and clones.", | |
| "type" : "string" | |
| }, | |
| "source_timestamp" : { | |
| "description" : "The source data time-stamp of the virtual volume.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "creation_timestamp" : { | |
| "description" : "Timestamp of the moment virtual volume was created at.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "location_history" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/location_history_instance" | |
| }, | |
| "description" : "Filtering on the fields of this embedded resource is not supported.", | |
| "x-no_filter" : true | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "usage_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to usage_type" | |
| }, | |
| "io_priority_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to io_priority" | |
| }, | |
| "creator_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to creator_type" | |
| }, | |
| "appliance" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/appliance_instance", | |
| "description" : "This is the embeddable reference form of appliance_id attribute.", | |
| "x-ref" : "appliance" | |
| }, | |
| "storage_container" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/storage_container_instance", | |
| "description" : "This is the embeddable reference form of storage_container_id attribute.", | |
| "x-ref" : "storage_container" | |
| }, | |
| "migration_session" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/migration_session_instance", | |
| "description" : "This is the embeddable reference form of migration_session_id attribute.", | |
| "x-ref" : "migration_session" | |
| }, | |
| "parent" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/virtual_volume_instance", | |
| "description" : "This is the embeddable reference form of parent_id attribute.", | |
| "x-ref" : "virtual_volume" | |
| }, | |
| "child_virtual_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/virtual_volume_instance", | |
| "x-ref" : "virtual_volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type virtual_volume association." | |
| }, | |
| "source" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/virtual_volume_instance", | |
| "description" : "This is the embeddable reference form of source_id attribute.", | |
| "x-ref" : "virtual_volume" | |
| }, | |
| "target_virtual_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/virtual_volume_instance", | |
| "x-ref" : "virtual_volume_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type virtual_volume association." | |
| }, | |
| "host_virtual_volume_mappings" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_virtual_volume_mapping_instance", | |
| "x-ref" : "host_virtual_volume_mapping_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type host_virtual_volume_mapping association." | |
| } | |
| } | |
| }, | |
| "VirtualVolumeTypeEnum" : { | |
| "description" : "The logical type of a virtual volume.", | |
| "type" : "string", | |
| "enum" : [ "Primary", "Snapshot", "Prepared_Snapshot", "Clone", "Fast_Clone" ], | |
| "x-display_enum_text" : { | |
| "Primary" : "Primary", | |
| "Snapshot" : "Snapshot", | |
| "Prepared_Snapshot" : "Prepared Snapshot", | |
| "Clone" : "Clone", | |
| "Fast_Clone" : "Fast Clone" | |
| } | |
| }, | |
| "VirtualVolumeUsageTypeEnum" : { | |
| "description" : "VMware's usage of the vVol.", | |
| "type" : "string", | |
| "enum" : [ "Config", "Data", "Swap", "Memory", "Other" ], | |
| "x-display_enum_text" : { | |
| "Config" : "Config", | |
| "Data" : "Data", | |
| "Swap" : "Swap", | |
| "Memory" : "Memory", | |
| "Other" : "Other" | |
| } | |
| }, | |
| "vvol_error_response" : { | |
| "type" : "object", | |
| "properties" : { | |
| "error_code" : { | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VirtualMachineTypeEnum" : { | |
| "description" : "Type of VM:\n* Primary - A base VM.\n* Template - A VM template.\n* Snapshot - A snapshot of a VM.\n", | |
| "type" : "string", | |
| "enum" : [ "Primary", "Template", "Snapshot" ], | |
| "x-display_enum_text" : { | |
| "Primary" : "Primary", | |
| "Template" : "Template", | |
| "Snapshot" : "Snapshot" | |
| } | |
| }, | |
| "VirtualMachineStatusEnum" : { | |
| "description" : "General health status of the VM in vCenter. Not applicable to VM snapshots.\n* Green - VM is operating normally.\n* Yellow - VM is operating normally, but there are potential issues.\n* Red - VM is experiencing issues and is not operating normally.\n* Grey - Status of the VM cannot be determined.\n", | |
| "type" : "string", | |
| "enum" : [ "Green", "Yellow", "Red", "Gray" ], | |
| "x-display_enum_text" : { | |
| "Green" : "Green", | |
| "Yellow" : "Yellow", | |
| "Red" : "Red", | |
| "Gray" : "Gray" | |
| } | |
| }, | |
| "vm_protection_data_instance" : { | |
| "type" : "object", | |
| "description" : "Protection data associated with the VM snapshot. \nFiltering on the fields of this embedded resource is not supported.", | |
| "properties" : { | |
| "created_by_rule_id" : { | |
| "description" : "Unique identifier of the protection rule that created the VM snapshot.", | |
| "type" : "string" | |
| }, | |
| "created_by_rule_name" : { | |
| "type" : "string", | |
| "description" : "Name of the rule that created the VM snapshot. This value is not updated if the name of the rule changes after snapshot creation." | |
| }, | |
| "creator_type" : { | |
| "$ref" : "#/definitions/StorageCreatorTypeEnum" | |
| }, | |
| "expiration_timestamp" : { | |
| "description" : "Date when the VM snapshot can be automatically purged.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "source_timestamp" : { | |
| "description" : "Time when the snapshot was created.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "source_id" : { | |
| "description" : "For VM snapshots, this value is the same as parent_id.", | |
| "type" : "string" | |
| }, | |
| "parent_id" : { | |
| "description" : "VM from which the snapshot was created.", | |
| "type" : "string" | |
| }, | |
| "creator_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to creator_type" | |
| } | |
| }, | |
| "x-no_filter" : true | |
| }, | |
| "virtual_machine_instance" : { | |
| "type" : "object", | |
| "description" : "Properties of a virtual machine.\r\nThis resource type has queriable associations from policy, virtual_machine", | |
| "x-select_cli" : [ "id", "name", "type", "memory_mb", "cpu_count", "guest_os", "status", "protection_policy_id" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the VM instance. This value is generated by the appliance." | |
| }, | |
| "instance_uuid" : { | |
| "type" : "string", | |
| "description" : "UUID instance of the VM in vCenter. This value is stored in the VM and migrates with the VM to other vCenter instances. Not applicable to VM snapshots." | |
| }, | |
| "vcenter_instance_uuid" : { | |
| "type" : "string", | |
| "description" : "UUID instance of the vCenter that hosts the VM." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "User-assigned name of the VM in vCenter. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "Description of the VM in vCenter." | |
| }, | |
| "type" : { | |
| "$ref" : "#/definitions/VirtualMachineTypeEnum" | |
| }, | |
| "memory_mb" : { | |
| "type" : "integer", | |
| "description" : "Memory size of the VM, in megabytes. Not applicable to VM snapshots.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "cpu_count" : { | |
| "type" : "integer", | |
| "description" : "Number of virtual CPUs in the VM. Not applicable to VM snapshots.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "guest_os" : { | |
| "type" : "string", | |
| "description" : "Guest operating system of the VM. Not applicable to VM snapshots." | |
| }, | |
| "status" : { | |
| "$ref" : "#/definitions/VirtualMachineStatusEnum" | |
| }, | |
| "protection_policy_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the protection policy assigned to the VM. Not applicable to template and snapshot VMs." | |
| }, | |
| "is_consistent" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the VM snapshot is crash-consistent." | |
| }, | |
| "is_consistent_snaps_supported" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the VM supports creating crash-consistent snapshots. Not applicable to snapshot VMs." | |
| }, | |
| "protection_data" : { | |
| "$ref" : "#/definitions/vm_protection_data_instance" | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "status_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to status" | |
| }, | |
| "protection_policy" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/policy_instance", | |
| "description" : "This is the embeddable reference form of protection_policy_id attribute.", | |
| "x-ref" : "policy" | |
| }, | |
| "parent" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/virtual_machine_instance", | |
| "description" : "This is the embeddable reference form of parent_id attribute.", | |
| "x-ref" : "virtual_machine" | |
| }, | |
| "children" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/virtual_machine_instance", | |
| "x-ref" : "virtual_machine_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type virtual_machine association." | |
| } | |
| } | |
| }, | |
| "virtual_machine_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "protection_policy_id" : { | |
| "description" : "Unique identifier of the protection policy.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "virtual_machine_snapshot" : { | |
| "type" : "object", | |
| "properties" : { | |
| "name" : { | |
| "description" : "Name of the snapshot. This value must contain 80 or fewer printable Unicode characters.", | |
| "type" : "string", | |
| "maxLength" : 80 | |
| }, | |
| "description" : { | |
| "description" : "Description of the snapshot. This value must contain 2000 or fewer printable Unicode characters.", | |
| "type" : "string", | |
| "maxLength" : 2000 | |
| } | |
| } | |
| }, | |
| "virtual_machine_snapshot_response" : { | |
| "type" : "object", | |
| "description" : "The response to a virtual_machine snapshot request.", | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique id of the new snapshot." | |
| } | |
| } | |
| }, | |
| "import_session_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "description", "remote_system_id", "source_resource_id", "destination_resource_id", "state", "estimated_completion_timestamp", "progress_percentage" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the import session." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "User-specified name of the import session. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "User-specified description of the import session." | |
| }, | |
| "remote_system_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the storage system that contains the source volume or consistency group to be imported." | |
| }, | |
| "source_resource_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the volume or consistency group to be imported." | |
| }, | |
| "destination_resource_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the destination volume or volume group created as part of the import process." | |
| }, | |
| "destination_resource_type" : { | |
| "$ref" : "#/definitions/ImportDestinationResourceTypeEnum" | |
| }, | |
| "parent_session_id" : { | |
| "type" : "string", | |
| "description" : "For a volume that is part of a consistency group import, this value is the session identifier of the import session. For an individual volume import, this value is null." | |
| }, | |
| "state" : { | |
| "$ref" : "#/definitions/ImportSessionStateEnum" | |
| }, | |
| "estimated_completion_timestamp" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "When the import is in the Copy_In_Progress state, this value indicates the estimated time at which the data copy will complete. Before the import is in the Copy_In_Progress state, the value is null." | |
| }, | |
| "progress_percentage" : { | |
| "type" : "integer", | |
| "description" : "When the import is in the Copy_In_Progress state, this value indicates the completion percent for the import. Before the import is in the Copy_In_Progress state, this value is 0. After the cutover or if there is a failure, this value is null.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "average_transfer_rate" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "description" : "Average transfer rate of a data import operation in bytes/sec over the whole copy period. Before and after the import is in the Copy_In_Progress state, this value is null.", | |
| "x-units" : "bytes", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "current_transfer_rate" : { | |
| "type" : "integer", | |
| "format" : "int64", | |
| "description" : "Current transfer rate of a data import operation in bytes/sec. Before and after the import is in the Copy_In_Progress state, this value is null.", | |
| "x-units" : "bytes", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "protection_policy_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the local protection policy in the PowerStore storage system that will be applied on an imported destination volume or consistency group after cutover. Only snapshot policies are supported in an import. Once the import completes, you can add a replication policy." | |
| }, | |
| "volume_group_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the volume group to which the destination volume will be added, if any." | |
| }, | |
| "automatic_cutover" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "Indicates whether the import session cutover is manual (true) or automatic (false)." | |
| }, | |
| "scheduled_timestamp" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Date and time at which the import session is scheduled to run. The date is specified in ISO 8601 format with the time expressed in UTC format." | |
| }, | |
| "error" : { | |
| "$ref" : "#/definitions/error_instance" | |
| }, | |
| "last_update_timestamp" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Date and time when was the import was last updated. This value is updated each time the import job updates." | |
| }, | |
| "destination_resource_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to destination_resource_type" | |
| }, | |
| "state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to state" | |
| }, | |
| "remote_system" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/remote_system_instance", | |
| "description" : "This is the embeddable reference form of remote_system_id attribute.", | |
| "x-ref" : "remote_system" | |
| } | |
| }, | |
| "description" : "This resource type has queriable association from remote_system" | |
| }, | |
| "error_instance" : { | |
| "type" : "object", | |
| "properties" : { | |
| "code" : { | |
| "type" : "string", | |
| "description" : "Hexadecimal error code for an import error." | |
| }, | |
| "message_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized error message." | |
| }, | |
| "arguments" : { | |
| "type" : "array", | |
| "description" : "Arguments (if applicable) for the error message.", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "description" : "Filtering on the fields of this embedded resource is not supported.", | |
| "x-no_filter" : true | |
| }, | |
| "import_session_create" : { | |
| "type" : "object", | |
| "required" : [ "remote_system_id", "source_resource_id", "name" ], | |
| "properties" : { | |
| "remote_system_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the storage system that contains the source volume or consistency group to be imported. You can query the source volume or consistency group object to get the identifier of the source system that the volume or consistency group are part of. Alternatively, you can use the remote_system object to get this information." | |
| }, | |
| "source_resource_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the volume or consistency group to be imported. Refer to the following objects for more information: * Storage Center : import_storage_center_volume, import_storage_center_consistency_group * VNX : import_vnx_volume, import_vnx_consistency_group * PS Series : import_psgroup_volume * Unity : import_unity_volume, import_unity_consistency_group" | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the import session. The name must be unique in the PowerStore cluster and can contain a maximum of 128 unicode characters. It cannot contain special HTTP characters, unprintable characters, or white space.", | |
| "maxLength" : 128 | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "Description of the import session. The name can contain a maximum of 128 unicode characters. It cannot contain unprintable characters.", | |
| "maxLength" : 128 | |
| }, | |
| "volume_group_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the volume group to which the imported volume will belong, if any." | |
| }, | |
| "automatic_cutover" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "Indicates whether the import session cutover is manual (true) or automatic (false)." | |
| }, | |
| "protection_policy_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the protection policy that will be applied to an imported volume or consistency group after the import completes. Only snapshot policies are supported in an import. Once the import completes, you can add a replication policy. If you try to import a replication policy, the import job will fail." | |
| }, | |
| "scheduled_timestamp" : { | |
| "type" : "string", | |
| "format" : "date-time", | |
| "description" : "Date and time at which the import session is scheduled to start. The date time is specified in ISO 8601 format with the time expressed in UTC format." | |
| } | |
| } | |
| }, | |
| "ImportSessionStateEnum" : { | |
| "description" : "Import session states\n* 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.\n* Paused : Indicates that the data copy between the source and destination volumes is paused.\n* Queued : Indicates that all imports are queued and run in a First In First Out (FIFO) order. This occurs when there are more active import sessions than supported.\n* In_Progress : Indicates that a queued import session is now in progress.\n* Mirror_Enabled : Indicates that an import session has completed setting up the entities required to import data from the source resource.\n* Ready_To_Start_Copy : Indicates that an import session is ready to start the data copy operation from the source resource.\n* Copy_In_Progress : Indicates that the data copy between the source and destination storage systems has started. The data copy runs as a background job and updates the import session percentage complete and estimated time left for the copy. Host IOs are pointed to PowerStore in this state. The import process keeps the source and destination volumes or consistency groups volume in sync by doing IO forwarding.\n* 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.\n* Cutover_In_Progress : Indicates that the cutover of volumes that are part of a consistency group is in progress.\n* 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.\n* Cancelled : Indicates that a user forcefully cancelled the import.\n* Failed : Indicates that there was an error during import. The appropriate error message is returned in the error_response object.\n* Cancel_Failed : Indicates that an attempt to cancel the import of a volume failed in a consistency group import.\n* Cancel_In_Progress : Indicates that a cancel is in progress.\n* Cleanup_In_Progress : Indicates that the import of one or more volumes in a consistency group failed. When this occurs, you must roll back the import of the other volumes of the consistency group by executing a Cancel operation on each volume.\n* Cleanup_Failed : Indicates that there was an error while cleaning up the consistency group.\n* Invalid : Indicates that an import session is in an unexpected state.\n* Cleanup_Required : Indicates that there was an error while cleaning up the import or consistency group that requires user intervention to bring back host applications.\n* Import_Completed_With_Errors : Indicates that there was a mirror failure for one or more members while committing a consistency group due to which members were partially committed.The failed members were cancelled.\n* Import_Cutover_Incomplete : Indicates that one or more members couldn't be committed successfully resulting in partial commit of the consistency group. Commit should be tried again on the consistency group.", | |
| "type" : "string", | |
| "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" ], | |
| "x-display_enum_text" : { | |
| "Scheduled" : "Scheduled", | |
| "Paused" : "Paused", | |
| "Queued" : "Queued", | |
| "In_Progress" : "In Progress", | |
| "Mirror_Enabled" : "Mirror Enabled", | |
| "Ready_To_Start_Copy" : "Ready To Start Copy", | |
| "Copy_In_Progress" : "Copy In Progress", | |
| "Ready_For_Cutover" : "Ready For Cutover", | |
| "Cutover_In_Progress" : "Cutover In Progress", | |
| "Import_Completed" : "Import Completed", | |
| "Cancelled" : "Cancelled", | |
| "Failed" : "Failed", | |
| "Cancel_Failed" : "Cancel Failed", | |
| "Cancel_In_Progress" : "Cancel In Progress", | |
| "Cleanup_In_Progress" : "Cleanup In Progress", | |
| "Cleanup_Failed" : "Cleanup Failed", | |
| "Invalid" : "Invalid", | |
| "Cleanup_Required" : "Cleanup Required", | |
| "Import_Completed_With_Errors" : "Import Completed With Errors", | |
| "Import_Cutover_Incomplete" : "Import Cutover Incomplete" | |
| } | |
| }, | |
| "ImportDestinationResourceTypeEnum" : { | |
| "description" : "Storage resource type of the import destination. Values are: * volume - The destination resource of the import session is a volume. * volume_group - The destination resource of the import session is a volume group.", | |
| "type" : "string", | |
| "enum" : [ "volume", "volume_group" ], | |
| "x-display_enum_text" : { | |
| "volume" : "Volume", | |
| "volume_group" : "Volume Group" | |
| } | |
| }, | |
| "import_session_cancel" : { | |
| "type" : "object", | |
| "properties" : { | |
| "force" : { | |
| "description" : "Indicates whether the cancel import session operation is a normal cancel (true) or a forced stop (false). For a forced stop, the import job terminates without rolling back in source or host down failover scenarios.", | |
| "type" : "boolean", | |
| "default" : false | |
| } | |
| } | |
| }, | |
| "import_session_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "scheduled_timestamp" : { | |
| "description" : "Indicates the new date and time at which the import session is scheduled to run. The date is specified in ISO 8601 format with time expressed in UTC format.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| } | |
| } | |
| }, | |
| "local_user_instance" : { | |
| "type" : "object", | |
| "description" : "Information about a local user.", | |
| "x-select_cli" : [ "id", "name", "is_built_in", "is_locked", "role_id" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the local user account." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the local user account." | |
| }, | |
| "is_built_in" : { | |
| "type" : "boolean", | |
| "description" : "Whether the user account is built-in or not." | |
| }, | |
| "is_locked" : { | |
| "type" : "boolean", | |
| "description" : "Whether the user account is locked or not. Defaults to false at creation time." | |
| }, | |
| "is_default_password" : { | |
| "type" : "boolean", | |
| "description" : "Whether the user account has a default password or not. Only applies to default user accounts." | |
| }, | |
| "role_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the role local user account is mapped to." | |
| } | |
| } | |
| }, | |
| "local_user_create" : { | |
| "type" : "object", | |
| "description" : "Parameters for creating a local user.", | |
| "required" : [ "name", "role_id", "password" ], | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the new local user account to be created. The name value can be 1 to 64 UTF-8 characters long, and may only use alphanumeric characters. Dot(.) is the only special character allowed." | |
| }, | |
| "password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "Password for the new local user account to be created. The password value can be 8 to 40 UTF-8 characters long, and include as a minimum one uppercase character, one lowercase character, one numeric character, and one special character from this list [!,@#$%^*>_~]." | |
| }, | |
| "role_id" : { | |
| "type" : "string", | |
| "description" : "The unique identifier of the role to which the new local user will be mapped. Where role_id \"1\" is for Administrator, \"2\" is for Storage Administrator, \"3\" is for Operator, \"4\" is for VM Administrator and \"5\" is for Security Administrator roles." | |
| } | |
| } | |
| }, | |
| "local_user_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "role_id" : { | |
| "type" : "string", | |
| "description" : "The unique identifier of the new role to which the local user has to be mapped. Where role_id \"1\" is for Administrator, \"2\" is for Storage Administrator, \"3\" is for Operator, \"4\" is for VM Administrator and \"5\" is for Security Administrator. A local user with either an administration or a security administration role can change the role of any other local user. You cannot change the role of the account you are currently logged-in to." | |
| }, | |
| "is_locked" : { | |
| "type" : "boolean", | |
| "description" : "Lock or unlock the local user account. Local user with administration/security administration role can lock or unlock any other local user account. You cannot lock an account you are currently logged-in to." | |
| }, | |
| "current_password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "Current password of the local user. Any local user can change his own password by providing current_password along with the new password." | |
| }, | |
| "password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "New password of the local user. Local user with administrator or security administrator role can reset the password of other local user accounts without providing the current password. You cannot reset the password of the account you are currently logged-in to." | |
| } | |
| } | |
| }, | |
| "login_session_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "user", "idle_timeout", "is_password_change_required" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the login session." | |
| }, | |
| "user" : { | |
| "type" : "string", | |
| "description" : "Fully qualified user account name being used to log in." | |
| }, | |
| "role_ids" : { | |
| "description" : "Roles to which the logged-in user is mapped.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "idle_timeout" : { | |
| "type" : "integer", | |
| "description" : "Remaining idle time until the session will expire, in seconds.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "is_password_change_required" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the logged-in user requires a password change." | |
| }, | |
| "is_built_in_user" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the logged-in user is predefined." | |
| } | |
| } | |
| }, | |
| "role_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "is_built_in", "description" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the role." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the role." | |
| }, | |
| "is_built_in" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the role is built-in." | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "Description of the role." | |
| } | |
| } | |
| }, | |
| "security_config_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "idle_timeout" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the system security configuration." | |
| }, | |
| "idle_timeout" : { | |
| "type" : "integer", | |
| "description" : "Idle time (in seconds) after which login sessions will expire and require re-authentication.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| } | |
| } | |
| }, | |
| "service_user_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "is_built_in" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the service user account." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the service user account. Always 'service' in this release." | |
| }, | |
| "is_built_in" : { | |
| "type" : "boolean", | |
| "description" : "Whether the user account is built-in or not." | |
| }, | |
| "is_default_password" : { | |
| "type" : "boolean", | |
| "description" : "Whether the user account has the default password or not." | |
| } | |
| } | |
| }, | |
| "service_user_modify" : { | |
| "type" : "object", | |
| "required" : [ "password" ], | |
| "properties" : { | |
| "password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "New password for the service user account. The password value can be 8 to 40 UTF-8 characters long, and include as a minimum one uppercase character, one lowercase character, one numeric character, and one special character from this list [!,@#$%^*>_~]." | |
| } | |
| } | |
| }, | |
| "X509CertificateUsageTypeEnum" : { | |
| "description" : "Usage of the certificate and the valid values are:\n* Server - Server Certificate\n* Client - Client Certificate\n* CA Client Validation - A CA certificate used to authenticate clients during an SSL handshake.\n* CA Server Validation - A CA certificate used to verify the server during an SSL handshake.\n\n", | |
| "type" : "string", | |
| "enum" : [ "Server", "Client", "CA_Client_Validation", "CA_Server_Validation" ], | |
| "x-display_enum_text" : { | |
| "Server" : "Server", | |
| "Client" : "Client", | |
| "CA_Client_Validation" : "CA_Client_Validation", | |
| "CA_Server_Validation" : "CA_Server_Validation" | |
| } | |
| }, | |
| "X509CertificateServiceEnum" : { | |
| "description" : "Type of the service for which the certificate is used:\n* Management HTTP - Management Web server\n* Replication HTTP - Remote Replication service\n* VASA HTTP - VASA provider service\n* Import HTTP - External web service\n", | |
| "type" : "string", | |
| "enum" : [ "Management_HTTP", "Replication_HTTP", "VASA_HTTP", "Import_HTTP" ], | |
| "x-display_enum_text" : { | |
| "Management_HTTP" : "Management HTTP", | |
| "Replication_HTTP" : "Replication HTTP", | |
| "VASA_HTTP" : "VASA HTTP", | |
| "Import_HTTP" : "Import HTTP" | |
| } | |
| }, | |
| "ThumbprintAlgorithmEnum" : { | |
| "description" : "The thumbprint algorithm:\n- SHA-256 : SHA-256 algorithm\n \n", | |
| "type" : "string", | |
| "enum" : [ "SHA-256" ], | |
| "x-display_enum_text" : { | |
| "SHA-256" : "SHA-256" | |
| } | |
| }, | |
| "member_certificate_instance" : { | |
| "description" : "Embedded member certificate in x509_certificate.", | |
| "type" : "object", | |
| "properties" : { | |
| "subject" : { | |
| "description" : "Certificate subject or so called distinguished name.", | |
| "type" : "string" | |
| }, | |
| "serial_number" : { | |
| "description" : "Certificate serial number.", | |
| "type" : "string" | |
| }, | |
| "signature_algorithm" : { | |
| "description" : "Certificate signature algorithm.", | |
| "type" : "string" | |
| }, | |
| "issuer" : { | |
| "description" : "Distinguished name of the certificate issuer.", | |
| "type" : "string" | |
| }, | |
| "valid_from" : { | |
| "description" : "Date and time when the certificate becomes valid.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "valid_to" : { | |
| "description" : "Date and time when the certificate will expire.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "subject_alternative_names" : { | |
| "description" : "Additional DNS names or IP addresses in the x509_certificate.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "public_key_algorithm" : { | |
| "description" : "Public key algorithm used to generate the key pair.", | |
| "type" : "string" | |
| }, | |
| "key_length" : { | |
| "description" : "Private key length.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "thumbprint_algorithm" : { | |
| "$ref" : "#/definitions/ThumbprintAlgorithmEnum" | |
| }, | |
| "thumbprint" : { | |
| "description" : "Hash value of the certificate.", | |
| "type" : "string" | |
| }, | |
| "certificate" : { | |
| "description" : "Base64 encoded certificate without any line breaks.", | |
| "type" : "string" | |
| }, | |
| "depth" : { | |
| "description" : "Depth indicates the position of this member certificate in the X509 Certificate chain. End-entity certificate will always have a depth of 1, which is the minimum value for depth. The depth of direct issuer certificate will be incremented by 1 until reaching the root certificate. Root certificate should have the largest depth for the certificate chain.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "thumbprint_algorithm_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to thumbprint_algorithm" | |
| } | |
| } | |
| }, | |
| "x509_certificate_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "type", "service", "is_current", "is_valid" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of X509 Certificate instance.", | |
| "type" : "string" | |
| }, | |
| "type" : { | |
| "$ref" : "#/definitions/X509CertificateUsageTypeEnum" | |
| }, | |
| "service" : { | |
| "$ref" : "#/definitions/X509CertificateServiceEnum" | |
| }, | |
| "is_current" : { | |
| "description" : "Indicates whether this is the current X509 Certificate to be used by the service or this X509 Certificate will be used in the future. When is_current is false for a X509 Certificate, this X509 Certificate will not be picked up by the service. Potential usage of this attribute is to prepare for the certificate roll-over/rotation.", | |
| "type" : "boolean" | |
| }, | |
| "is_valid" : { | |
| "description" : "Indicates whether this is a valid X509 Certificate. When X509 Certificate is expired or X509 Certificate of server type missing either a private key or a valid certificate entry, it will be false.", | |
| "type" : "boolean" | |
| }, | |
| "members" : { | |
| "description" : "Member certificates included in this x509_certificate. Member certificates should be remained in an ordered sequence. \nFiltering on the fields of this embedded resource is not supported.", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/member_certificate_instance" | |
| }, | |
| "x-no_filter" : true | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "service_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to service" | |
| } | |
| } | |
| }, | |
| "x509_certificate_exchange" : { | |
| "type" : "object", | |
| "description" : "x509 certificate exchange opertation request body.", | |
| "required" : [ "service", "address", "port", "username", "password" ], | |
| "properties" : { | |
| "service" : { | |
| "$ref" : "#/definitions/X509CertificateServiceEnum" | |
| }, | |
| "address" : { | |
| "description" : "Peer's ip v4 or v6 address or dns name.", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "port" : { | |
| "description" : "Peer's port number.", | |
| "type" : "integer", | |
| "minimum" : 0, | |
| "maximum" : 65535, | |
| "format" : "int32" | |
| }, | |
| "username" : { | |
| "description" : "Username used in basic authentication to remote PowerStore cluster.", | |
| "type" : "string" | |
| }, | |
| "password" : { | |
| "description" : "Password used in basic authentication to remote PowerStore cluster.", | |
| "type" : "string", | |
| "format" : "password" | |
| } | |
| } | |
| }, | |
| "x509_certificate_decommission" : { | |
| "type" : "object", | |
| "description" : "x509 certificate decommission operation request body.", | |
| "required" : [ "service", "scope" ], | |
| "properties" : { | |
| "service" : { | |
| "$ref" : "#/definitions/X509CertificateServiceEnum" | |
| }, | |
| "scope" : { | |
| "description" : "Scope of the certificate to be decommissioned, for example, remote system global id, serial number and such.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "host_instance" : { | |
| "x-select_cli" : [ "id", "name", "description", "os_type", "host_group.name" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique id of the host." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "The host name. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "A description for the host." | |
| }, | |
| "os_type" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/OSTypeEnum" | |
| }, | |
| "host_group_id" : { | |
| "type" : "string", | |
| "description" : "Associated host group, if host is part of host group." | |
| }, | |
| "host_initiators" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_initiator_instance" | |
| }, | |
| "description" : "Filtering on the fields of this embedded resource is not supported.", | |
| "x-no_filter" : true | |
| }, | |
| "os_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to os_type" | |
| }, | |
| "host_group" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/host_group_instance", | |
| "description" : "This is the embeddable reference form of host_group_id attribute.", | |
| "x-ref" : "host_group" | |
| }, | |
| "import_host_system" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/import_host_system_instance", | |
| "description" : "This is the embeddable reference form of import_host_system_id attribute.", | |
| "x-ref" : "import_host_system" | |
| }, | |
| "mapped_hosts" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_volume_mapping_instance", | |
| "x-ref" : "host_volume_mapping_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type host_volume_mapping association." | |
| }, | |
| "host_virtual_volume_mappings" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_virtual_volume_mapping_instance", | |
| "x-ref" : "host_virtual_volume_mapping_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type host_virtual_volume_mapping association." | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from host_group, import_host_system, host_volume_mapping, host_virtual_volume_mapping" | |
| }, | |
| "host_initiator_instance" : { | |
| "type" : "object", | |
| "properties" : { | |
| "port_name" : { | |
| "type" : "string", | |
| "description" : "IQN name aka address." | |
| }, | |
| "port_type" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/InitiatorProtocolTypeEnum" | |
| }, | |
| "chap_single_username" : { | |
| "type" : "string", | |
| "description" : "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.", | |
| "minLength" : 1, | |
| "maxLength" : 64 | |
| }, | |
| "chap_mutual_username" : { | |
| "type" : "string", | |
| "description" : "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.", | |
| "minLength" : 1, | |
| "maxLength" : 64 | |
| }, | |
| "active_sessions" : { | |
| "type" : "array", | |
| "description" : "Array of active login session between an initiator and a target port.", | |
| "items" : { | |
| "$ref" : "#/definitions/active_session_instance" | |
| } | |
| }, | |
| "port_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to port_type" | |
| } | |
| } | |
| }, | |
| "initiator_create_modify" : { | |
| "type" : "object", | |
| "required" : [ "port_name", "port_type" ], | |
| "properties" : { | |
| "port_name" : { | |
| "type" : "string", | |
| "description" : "IQN name aka address." | |
| }, | |
| "port_type" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/InitiatorProtocolTypeEnum" | |
| }, | |
| "chap_single_username" : { | |
| "type" : "string", | |
| "description" : "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.", | |
| "minLength" : 1, | |
| "maxLength" : 64 | |
| }, | |
| "chap_single_password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "Password for CHAP authentication. This value must be 12 to 64 UTF-8 characters. This password is not queriable. CHAP password is required when the cluster CHAP mode is mutual authentication.", | |
| "minLength" : 12, | |
| "maxLength" : 64 | |
| }, | |
| "chap_mutual_username" : { | |
| "type" : "string", | |
| "description" : "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.", | |
| "minLength" : 1, | |
| "maxLength" : 64 | |
| }, | |
| "chap_mutual_password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "Password for CHAP authentication. This value must be 12 to 64 UTF-8 characters. This password is not queriable. CHAP password is required when the cluster CHAP mode is mutual authentication.", | |
| "minLength" : 12, | |
| "maxLength" : 64 | |
| } | |
| } | |
| }, | |
| "active_session_instance" : { | |
| "type" : "object", | |
| "properties" : { | |
| "port_name" : { | |
| "type" : "string", | |
| "description" : "IQN or WWN of the target port that the initiator is logged into." | |
| }, | |
| "appliance_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the appliance containing the session." | |
| }, | |
| "node_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of node on the appliance on which active session is create." | |
| }, | |
| "bond_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the bond the initiator is logged into. Null if one of the following is non-null: veth_id, eth_port_id or fc_port_id." | |
| }, | |
| "fc_port_id" : { | |
| "type" : "string", | |
| "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 eth_port_id" | |
| }, | |
| "veth_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the virtual Ethernet port the initiator is logged into. Null if one of the following is non-null: bond, eth_port_id or fc_port_id." | |
| }, | |
| "eth_port_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the Ethernet port the initiator is logged into. Null if one of the following is non-null: bond_id, veth_id or fc_port_id." | |
| } | |
| } | |
| }, | |
| "host_create" : { | |
| "type" : "object", | |
| "required" : [ "name", "os_type", "initiators" ], | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "The host name. The name should not be more than 128 UTF-8 characters long and should not have any unprintable characters.", | |
| "maxLength" : 128 | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "An optional description for the host. The description should not be more than 256 UTF-8 characters long and should not have any unprintable characters.", | |
| "maxLength" : 256 | |
| }, | |
| "os_type" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/OSTypeEnum" | |
| }, | |
| "initiators" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/initiator_create_modify" | |
| } | |
| } | |
| } | |
| }, | |
| "host_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "The host name. The name should not be more than 128 UTF-8 characters long and should not have any unprintable characters.", | |
| "maxLength" : 128 | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "An optional description for the host. The description should not be more than 256 UTF-8 characters long and should not have any unprintable characters.", | |
| "maxLength" : 256 | |
| }, | |
| "remove_initiators" : { | |
| "description" : "The list of initiator port_names to be removed.", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "example" : "iqn-1992-01.com.example.3" | |
| } | |
| }, | |
| "add_initiators" : { | |
| "description" : "The list of initiators to be added. CHAP username and password are optional.", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/initiator_create_modify" | |
| } | |
| }, | |
| "modify_initiators" : { | |
| "description" : "Update list of existing initiators, identified by port_name, with new CHAP usernames and/or passwords.", | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/update_initiator_in_host" | |
| } | |
| } | |
| } | |
| }, | |
| "host_delete" : { | |
| "type" : "object", | |
| "properties" : { } | |
| }, | |
| "host_attach" : { | |
| "type" : "object", | |
| "description" : "Volume id and optional logical unit number for attaching to host.", | |
| "required" : [ "volume_id" ], | |
| "properties" : { | |
| "volume_id" : { | |
| "description" : "Volume to attach.", | |
| "type" : "string" | |
| }, | |
| "logical_unit_number" : { | |
| "description" : "Logical unit number for the volume, if desired.", | |
| "type" : "integer", | |
| "minimum" : 0, | |
| "maximum" : 16383, | |
| "format" : "int32" | |
| } | |
| } | |
| }, | |
| "host_detach" : { | |
| "type" : "object", | |
| "required" : [ "volume_id" ], | |
| "properties" : { | |
| "volume_id" : { | |
| "description" : "Volume to detach.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "update_initiator_in_host" : { | |
| "type" : "object", | |
| "properties" : { | |
| "port_name" : { | |
| "type" : "string", | |
| "description" : "Initiator name" | |
| }, | |
| "chap_single_username" : { | |
| "type" : "string", | |
| "description" : "Username for CHAP authentication. This value must be 1 to 64 printable UTF-8 characters. CHAP username is required when the cluster CHAP mode is mutual authentication.", | |
| "minLength" : 1, | |
| "maxLength" : 64 | |
| }, | |
| "chap_single_password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "Password for CHAP authentication. This value must be 12 to 64 printable UTF-8 characters. CHAP password is required when the cluster CHAP mode is mutual authentication.", | |
| "minLength" : 12, | |
| "maxLength" : 64 | |
| }, | |
| "chap_mutual_username" : { | |
| "type" : "string", | |
| "description" : "Username for CHAP authentication. This value must be 1 to 64 printable UTF-8 characters. CHAP username is required when the cluster CHAP mode is mutual authentication.", | |
| "minLength" : 1, | |
| "maxLength" : 64 | |
| }, | |
| "chap_mutual_password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "Password for CHAP authentication. This value must be 12 to 64 printable UTF-8 characters. CHAP password is required when the cluster CHAP mode is mutual authentication.", | |
| "minLength" : 12, | |
| "maxLength" : 64 | |
| } | |
| } | |
| }, | |
| "OSTypeEnum" : { | |
| "description" : "Operating system of the host.", | |
| "type" : "string", | |
| "enum" : [ "Windows", "Linux", "ESXi", "AIX", "HP-UX", "Solaris" ], | |
| "x-display_enum_text" : { | |
| "Windows" : "Windows", | |
| "Linux" : "Linux", | |
| "ESXi" : "ESXi", | |
| "AIX" : "AIX", | |
| "HP-UX" : "HP-UX", | |
| "Solaris" : "Solaris" | |
| }, | |
| "properties" : { } | |
| }, | |
| "InitiatorProtocolTypeEnum" : { | |
| "description" : "\nProtocol type of the host initiator.\n * iSCSI - An iSCSI initiator.\n * FC - A Fibre Channel initiator.", | |
| "type" : "string", | |
| "enum" : [ "iSCSI", "FC" ], | |
| "x-display_enum_text" : { | |
| "iSCSI" : "iSCSI", | |
| "FC" : "FC" | |
| } | |
| }, | |
| "host_group_instance" : { | |
| "x-select_cli" : [ "id", "name", "description" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "The host group unique identifier." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "The host group name. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "A description for the host group." | |
| }, | |
| "hosts" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_instance", | |
| "x-ref" : "host_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type host association." | |
| }, | |
| "mapped_host_groups" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_volume_mapping_instance", | |
| "x-ref" : "host_volume_mapping_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type host_volume_mapping association." | |
| }, | |
| "host_virtual_volume_mappings" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_virtual_volume_mapping_instance", | |
| "x-ref" : "host_virtual_volume_mapping_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type host_virtual_volume_mapping association." | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from host, host_volume_mapping, host_virtual_volume_mapping" | |
| }, | |
| "host_group_create" : { | |
| "type" : "object", | |
| "description" : "Create host group parameters.", | |
| "required" : [ "name", "host_ids" ], | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "The host group name. The name should not be more than 128 UTF-8 characters long and should not have any unprintable characters.", | |
| "maxLength" : 128 | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "An optional description for the host group. The description should not have any unprintable characters.", | |
| "maxLength" : 256 | |
| }, | |
| "host_ids" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "description" : "The list of hosts to include in the host group." | |
| } | |
| } | |
| } | |
| }, | |
| "host_group_modify" : { | |
| "type" : "object", | |
| "description" : "Modify host group parameters.", | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "A new host group name. The name should not be more than 128 UTF-8 characters long and should not have any unprintable characters.", | |
| "maxLength" : 128 | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "An optional description for the host group. The description should not be more than 256 UTF-8 characters long and should not have any unprintable characters.", | |
| "maxLength" : 256 | |
| }, | |
| "remove_host_ids" : { | |
| "type" : "array", | |
| "description" : "List of hosts to be removed from the host group. The operation fails if host group is attached to volume.", | |
| "items" : { | |
| "type" : "string", | |
| "example" : "2f5ea-f56f2-f638d-feffe-8feff" | |
| } | |
| }, | |
| "add_host_ids" : { | |
| "type" : "array", | |
| "description" : "List of hosts to be added to host group. The operation fails if the host(s) to be added are attached to volume.", | |
| "items" : { | |
| "type" : "string", | |
| "example" : "2f5ea-f56f2-f638d-feffe-8feff" | |
| } | |
| } | |
| } | |
| }, | |
| "host_group_attach" : { | |
| "type" : "object", | |
| "description" : "Volume id and optional logical unit number for attaching to host group.", | |
| "required" : [ "volume_id" ], | |
| "properties" : { | |
| "volume_id" : { | |
| "description" : "Volume to attach.", | |
| "type" : "string" | |
| }, | |
| "logical_unit_number" : { | |
| "description" : "Logical unit number for the volume, if desired.", | |
| "type" : "integer", | |
| "minimum" : 0, | |
| "maximum" : 16383, | |
| "format" : "int32" | |
| } | |
| } | |
| }, | |
| "host_group_detach" : { | |
| "type" : "object", | |
| "required" : [ "volume_id" ], | |
| "properties" : { | |
| "volume_id" : { | |
| "description" : "Volume to detach.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "cluster_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "name", "management_address", "storage_discovery_address", "master_appliance_id", "appliance_count", "state" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "The id of the cluster." | |
| }, | |
| "global_id" : { | |
| "type" : "string", | |
| "description" : "The global id of the cluster." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "The name of the cluster." | |
| }, | |
| "management_address" : { | |
| "type" : "string", | |
| "description" : "The management IP address.", | |
| "format" : "ip-address" | |
| }, | |
| "storage_discovery_address" : { | |
| "type" : "string", | |
| "description" : "The floating storage discovery address for the cluster.", | |
| "format" : "ip-address" | |
| }, | |
| "master_appliance_id" : { | |
| "type" : "string", | |
| "description" : "The id of the appliance acting as master." | |
| }, | |
| "appliance_count" : { | |
| "type" : "integer", | |
| "description" : "Number of appliances configured in this cluster.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "physical_mtu" : { | |
| "type" : "integer", | |
| "description" : "The physical ethernet port (eth_port resource) MTU setting, global for all ports in the cluster. This is the default MTU setting for IP traffic, and the upper limit on network-specific MTU settings (network resource), where this can be overridden for some specific kinds of traffic (management, data, and vmotion).", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "is_encryption_enabled" : { | |
| "type" : "boolean", | |
| "description" : "Whether or not Data at Rest Encryption is enabled on the cluster." | |
| }, | |
| "compatibility_level" : { | |
| "type" : "integer", | |
| "description" : "The behavioral version of the software version API, and it is used to help ensure compatibility across potentially different software versions.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "state" : { | |
| "$ref" : "#/definitions/ClusterStateEnum" | |
| }, | |
| "state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized string corresponding to state." | |
| } | |
| } | |
| }, | |
| "cluster_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "The name of the cluster. The name can be up to 64 UTF-8 characters and cannot be an empty string.", | |
| "minLength" : 1, | |
| "maxLength" : 64 | |
| }, | |
| "physical_mtu" : { | |
| "type" : "integer", | |
| "description" : "The physical ethernet port (eth_port resource) MTU setting, global for all ports in the cluster. This is the default MTU setting for IP traffic, and the upper limit on network-specific MTU settings (network resource), where this can be overridden for some specific kinds of traffic (management, data, and vmotion). This value must be in the range 1500-9000.", | |
| "minimum" : 1500, | |
| "maximum" : 9000, | |
| "format" : "int32" | |
| } | |
| } | |
| }, | |
| "ClusterStateEnum" : { | |
| "description" : "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. * Clustering_Failed - This is a single appliance that failed an attempt to join a cluster.", | |
| "type" : "string", | |
| "enum" : [ "Unconfigured_Faulted", "Unconfigured", "Configuring", "Configured", "Expanding", "Removing", "Clustering_Failed" ], | |
| "x-display_enum_text" : { | |
| "Unconfigured_Faulted" : "Unconfigured_Faulted", | |
| "Unconfigured" : "Unconfigured", | |
| "Configuring" : "Configuring", | |
| "Configured" : "Configured", | |
| "Expanding" : "Expanding", | |
| "Removing" : "Removing", | |
| "Clustering_Failed" : "Clustering_Failed" | |
| } | |
| }, | |
| "license_instance" : { | |
| "type" : "object", | |
| "description" : "Software license information for the cluster.", | |
| "x-select_cli" : [ "id", "is_licensed", "trial_expiration_timestamp" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique ididentifier of the cluster license." | |
| }, | |
| "is_licensed" : { | |
| "description" : "Whether or not the cluster currently has a valid license.", | |
| "type" : "boolean" | |
| }, | |
| "trial_expiration_timestamp" : { | |
| "description" : "If not currently licensed, the date the trial period expires. If the trial period expires, new provisioning operations will not be allowed.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "activation_file_content" : { | |
| "description" : "The content of the license activation file to send to the DellEMC Software Licensing Central to retrieve the software license for the cluster.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationHistoryReasonEnum" : { | |
| "description" : "Reason for storage resource relocation.\n * Initial - Initial placement.\n * Manual - Manual migration operation initiated by user.\n * Recommended - Storage system recommended migration.", | |
| "type" : "string", | |
| "enum" : [ "Initial", "Manual", "Recommended" ], | |
| "x-display_enum_text" : { | |
| "Initial" : "Initial", | |
| "Manual" : "Manual", | |
| "Recommended" : "Recommended" | |
| } | |
| }, | |
| "location_history_instance" : { | |
| "description" : "Storage resource location history. All entries are kept indefinitely and are removed when the resource object is deleted.", | |
| "properties" : { | |
| "from_appliance_id" : { | |
| "description" : "Unique identifier of the appliance from which the volume was relocated.", | |
| "type" : "string" | |
| }, | |
| "to_appliance_id" : { | |
| "description" : "Unique identifier of the appliance to which the volume was relocated.", | |
| "type" : "string" | |
| }, | |
| "reason" : { | |
| "$ref" : "#/definitions/LocationHistoryReasonEnum" | |
| }, | |
| "migrated_on" : { | |
| "description" : "Time when the storage resource location changed.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "reason_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to reason" | |
| } | |
| } | |
| }, | |
| "StorageCreatorTypeEnum" : { | |
| "description" : "Creator type of the storage resource. * User - A resource created by a user. * System - A resource created by the replication engine. * Scheduler - A resource created by the snapshot scheduler.", | |
| "type" : "string", | |
| "enum" : [ "User", "System", "Scheduler" ], | |
| "x-display_enum_text" : { | |
| "User" : "User", | |
| "System" : "System", | |
| "Scheduler" : "Scheduler" | |
| } | |
| }, | |
| "protection_data_instance" : { | |
| "type" : "object", | |
| "description" : "Protection data associated with a resource. \nFiltering on the fields of this embedded resource is not supported.", | |
| "properties" : { | |
| "created_by_rule_id" : { | |
| "description" : "Unique identifier of the snapshot rule that created the snapshot.", | |
| "type" : "string" | |
| }, | |
| "created_by_rule_name" : { | |
| "type" : "string", | |
| "description" : "The name of the rule that created the snapshot. This value will not change if the name of the rule changes after creating the snapshot." | |
| }, | |
| "creator_type" : { | |
| "description" : "StorageCreatorTypeEnum", | |
| "$ref" : "#/definitions/StorageCreatorTypeEnum" | |
| }, | |
| "expiration_timestamp" : { | |
| "description" : "Date when the snapshot can be automatically purged.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "source_timestamp" : { | |
| "description" : "The time at which the resource was sourced from the resource identified by source_id.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "family_id" : { | |
| "description" : "Family identifier of the resource. This is the identifier of the primary object at the root of the family tree. For a primary resource this will be the same as the id of the object. For snapshots and clone resources it will be set to the source object's family ID.", | |
| "type" : "string" | |
| }, | |
| "source_id" : { | |
| "description" : "Unique identifier of the resource from which a snapshot or clone resource is created. The parent_id is set when a resource is created and will only change if its parent resource is deleted. When a resource is deleted, its children get reparented to the parent of the deleted resource. If the deleted parent is of type Primary, the parent_id of the child resources will be set to null.", | |
| "type" : "string" | |
| }, | |
| "parent_id" : { | |
| "description" : "Unique identifier of the resource from which a snapshot or clone resource is created. The parent_id is set when a resource is created and will only change if its parent resource is deleted. When a resource is deleted, its children get reparented to the parent of the deleted resource. If the deleted parent is of type Primary, the parent_id of the child resources will be set to null.", | |
| "type" : "string" | |
| }, | |
| "copy_signature" : { | |
| "description" : "Used for tracking replicated copies of a snapshot set.", | |
| "type" : "string" | |
| }, | |
| "is_app_consistent" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "A boolean flag that indicates whether the snapshot is application consistent. Only App Sync can create application consistent snapshots." | |
| }, | |
| "creator_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to creator_type" | |
| } | |
| }, | |
| "x-no_filter" : true | |
| }, | |
| "VolumeStateEnum" : { | |
| "description" : "Volume life cycle states.\n * Ready - Volume is operating normally.\n * Initializing - Volume is starting but not yet ready for use.\n * Offline - Volume is not available.\n * Destroying - Volume is being deleted. No new operations are allowed.", | |
| "type" : "string", | |
| "enum" : [ "Ready", "Initializing", "Offline", "Destroying" ], | |
| "x-display_enum_text" : { | |
| "Ready" : "Ready", | |
| "Initializing" : "Initializing", | |
| "Offline" : "Offline", | |
| "Destroying" : "Destroying" | |
| } | |
| }, | |
| "VolumeTypeEnum" : { | |
| "description" : "Type of volume.\n * Primary - A base object.\n * Clone - A read-write object that shares storage with the object from which it is sourced.\n * Snapshot - A read-only object created from a volume or clone.", | |
| "type" : "string", | |
| "enum" : [ "Primary", "Clone", "Snapshot" ], | |
| "x-display_enum_text" : { | |
| "Primary" : "Primary", | |
| "Clone" : "Clone", | |
| "Snapshot" : "Snapshot" | |
| } | |
| }, | |
| "NodeAffinityEnum" : { | |
| "description" : "This attribute shows which node will be advertised as the optimized IO path to the volume. It is initially set to System_Select_At_Attach and can be modified to other values. When a volume is first attached to a host, if node_affinity is System_Select_At_Attach then the system will make the assignment to either System_Selected_Node_A or System_Selected_Node_B. The node_affinity may be modified to one of System_Select_At_Attach or Preferred_Node_A or Preferred_Node_B. Both System_Selected_Node_A and System_Selected_Node_B are reserved for system use only and cannot be set as the volume's node_affinity.\n\nPossible affinity for a volume.\n * System_Select_At_Attach - Volume currently has no node affinity, affinity will be assigned when the volume is first attached.\n * System_Selected_Node_A - System selected Node A as the optimized IO path to volume.\n * System_Selected_Node_B - System selected Node B as the optimized IO path to volume.\n * Preferred_Node_A - Node A will always advertise as the optimized IO path to volume.\n * Preferred_Node_B - Node B will always advertise as the optimized IO path to volume.", | |
| "type" : "string", | |
| "enum" : [ "System_Select_At_Attach", "System_Selected_Node_A", "System_Selected_Node_B", "Preferred_Node_A", "Preferred_Node_B" ], | |
| "x-display_enum_text" : { | |
| "System_Select_At_Attach" : "System Select At Attach", | |
| "System_Selected_Node_A" : "System Selected Node A", | |
| "System_Selected_Node_B" : "System Selected Node B", | |
| "Preferred_Node_A" : "Preferred Node A", | |
| "Preferred_Node_B" : "Preferred Node B" | |
| } | |
| }, | |
| "HardwareTypeEnum" : { | |
| "type" : "string", | |
| "description" : "The type of hardware component. Current types are:\n * Appliance - The System including the Base Enclosure and optional Expansion Enclosures.\n * Base_Enclosure - The enclosure containing 2 Nodes and 25 NVME drive slots.\n * Node - The component that contains the processors and DIMMs.\n * Expansion_Enclosure - The enclosures that contain additional SAS storage.\n * Power_Supply - The AC Power Supply that powers each Node.\n * IO_Module - The component that provides front-end I/O connectivity to each Node.\n * Link_Control_Card - The IO card that provides SAS Connectivity to the Expansion Enclosure.\n * SFP - The Small Form-factor Pluggable (SFP) that is used for networking.\n * Battery - The internal battery backup used by each Node.\n * DIMM - The memory sticks that are installed in each Node.\n * M2_Drive - The internal M.2 SATA drive used for Node boot and recovery.\n * Fan - The fan module that provides cooling to the Node.\n * Drive - The NVME drives installed in the Base Enclosure or the SAS drives installed in an Expansion Enclosure.\n", | |
| "enum" : [ "Appliance", "Node", "Base_Enclosure", "Expansion_Enclosure", "Power_Supply", "IO_Module", "Link_Control_Card", "SFP", "Battery", "DIMM", "M2_Drive", "Fan", "Drive" ], | |
| "x-display_enum_text" : { | |
| "Appliance" : "Appliance", | |
| "Node" : "Node", | |
| "Base_Enclosure" : "Base enclosure", | |
| "Expansion_Enclosure" : "Expansion enclosure", | |
| "Power_Supply" : "Power supply", | |
| "IO_Module" : "IO module", | |
| "Link_Control_Card" : "Link control card", | |
| "SFP" : "SFP", | |
| "Battery" : "Battery", | |
| "DIMM" : "DIMM", | |
| "M2_Drive" : "M2 drive", | |
| "Fan" : "Fan", | |
| "Drive" : "Drive" | |
| } | |
| }, | |
| "HardwareLifecycleStateEnum" : { | |
| "type" : "string", | |
| "description" : "Lifecycle state of the Hardware. Current values are:\n * Uninitialized - System is starting up.\n * Healthy - Hardware is healthy.\n * Initializing - System is starting up.\n * Failed - Hardware has failed.\n * Disconnected - Hardware was removed from the system.\n * Prepare_Failed - Transient state used during startup.\n * Trigger_Update - Transient state used during startup.\n * Empty - No hardware present in this location.\n", | |
| "enum" : [ "Uninitialized", "Healthy", "Initializing", "Failed", "Disconnected", "Prepare_Failed", "Trigger_Update", "Empty" ], | |
| "x-display_enum_text" : { | |
| "Uninitialized" : "Uninitialized", | |
| "Healthy" : "Healthy", | |
| "Initializing" : "Initializing", | |
| "Failed" : "Failed", | |
| "Disconnected" : "Disconnected", | |
| "Prepare_Failed" : "Prepare failed", | |
| "Trigger_Update" : "Trigger update", | |
| "Empty" : "Empty" | |
| } | |
| }, | |
| "HardwareStatusLEDStateEnum" : { | |
| "type" : "string", | |
| "description" : "State of the status LED of the hardware. The LED is On when there is a hardware fault. Current values are: \n * Off - Hardware Status LED is turned off.\n * On - Hardware Status LED is turned on.\n", | |
| "enum" : [ "Off", "On" ], | |
| "x-display_enum_text" : { | |
| "Off" : "Off", | |
| "On" : "On" | |
| } | |
| }, | |
| "hardware_modify" : { | |
| "description" : "Hardware properties to modify.", | |
| "required" : [ "is_marked" ], | |
| "properties" : { | |
| "is_marked" : { | |
| "description" : "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. Note that the state returned in the hardware component may not actually change for up to 60 seconds. This operation is currently supported for Base_Enclosure, Expansion_Enclosure, Node and Drive. Note that operations at the Base_Enclosure and Expansion_Enclosure apply to their children (Nodes and Drives for Base_Enclosure and Drives for Expansion_Enclosure). For components with a single physical LED (Base_Enclosure and Node), setting is_marked=true overrides the status_led_state property from on (or off) to Null, and setting is_marked=false reverts status_led_state to showing the state of the physical LED.", | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "HardwareSFPModeEnum" : { | |
| "type" : "string", | |
| "description" : "SFP mode. Available on the SFP hardware type. Current modes are:\n * Unknown - This SFP has unknown support.\n * Multi_Mode - This SFP supports multi-mode fiber.\n * Single_Mode - This SFP supports single-mode fiber.\n", | |
| "enum" : [ "Unknown", "Multi_Mode", "Single_Mode" ], | |
| "x-display_enum_text" : { | |
| "Unknown" : "Unknown", | |
| "Multi_Mode" : "Multi-mode", | |
| "Single_Mode" : "Single-mode" | |
| } | |
| }, | |
| "HardwareSFPSpeedEnum" : { | |
| "type" : "string", | |
| "description" : "Supported speed. Available on the SFP hardware type. Current supported speeds are:\n * Auto - Automatically selected link speed\n * 4_Gbps - 4 Gigabits per second\n * 8_Gbps - 8 Gigabits per second\n * 16_Gbps - 16 Gigabits per second\n * 32_Gbps - 32 Gigabits per second\n * 10_Mbps - 10 Megabits per second\n * 100_Mbps - 100 Megabits per second\n * 1_Gbps - 1 Gigabit per second\n * 10_Gbps - 10 Gigabits per second\n * 25_Gbps - 25 Gigabits per second\n * 40_Gbps - 40 Gigabits per second\n", | |
| "enum" : [ "Auto", "4_Gbps", "8_Gbps", "16_Gbps", "32_Gbps", "10_Mbps", "100_Mbps", "1_Gbps", "10_Gbps", "25_Gbps", "40_Gbps" ], | |
| "x-display_enum_text" : { | |
| "Auto" : "Auto", | |
| "4_Gbps" : "4 Gbps", | |
| "8_Gbps" : "8 Gbps", | |
| "16_Gbps" : "16 Gbps", | |
| "32_Gbps" : "32 Gbps", | |
| "10_Mbps" : "10 Mbps", | |
| "100_Mbps" : "100 Mbps", | |
| "1_Gbps" : "1 Gbps", | |
| "10_Gbps" : "10 Gbps", | |
| "25_Gbps" : "25 Gbps", | |
| "40_Gbps" : "40 Gbps" | |
| } | |
| }, | |
| "HardwareSFPSupportedProtocolEnum" : { | |
| "type" : "string", | |
| "description" : "Supported protocol. Available on the SFP hardware type. Current protocols are:\n * Unknown - This SFP has unknown protocol support.\n * FC - This SFP supports Fibre Channel.\n * Ethernet - This SFP supports Ethernet.\n * FC_Ethernet - This SFP supports Fibre Channel or Ethernet.\n * SAS - This SFP supports SAS for connections to Expansion Enclosures.\n", | |
| "enum" : [ "Unknown", "FC", "Ethernet", "FC_Ethernet", "SAS" ], | |
| "x-display_enum_text" : { | |
| "Unknown" : "Unknown", | |
| "FC" : "FC", | |
| "Ethernet" : "Ethernet", | |
| "FC_Ethernet" : "FC, Ethernet", | |
| "SAS" : "SAS" | |
| } | |
| }, | |
| "HardwareSFPConnectorTypeEnum" : { | |
| "type" : "string", | |
| "description" : "Connector type. Available on the SFP hardware type. Current types are:\n * Unknown - Unknown Connector\n * SC - Subscriber Connector\n * FC_Style1_Copper - Fibre Channel Style 1 Copper Connector\n * FC_Style2_Copper - Fibre Channel Style 1 Copper Connector\n * BNC_TNC - Bayonet/Threaded Neill-Concelman Connector\n * FC_Coaxial_Headers - Fibre Channel Coaxial Headers Connector\n * FiberJack - Fiber Jack Connector\n * LC - Lucent Connector\n * MT_RJ - Mechanical Transfer - Registered Jack Connector\n * MU - Multiple Optical Connector\n * SG - SG Connector\n * Optical_Pigtail - Optical Pigtail Connector\n * HSSDC_II - High Speed Serial Data Connector\n * Copper_Pigtail - Copper Pigtail Connector\n * RJ45 - RJ45 Connector\n * No_Separable - Non-seperable Connector\n * MXC_2x16 - MXC 2x16 Connector\n", | |
| "enum" : [ "Unknown", "SC", "FC_Style1_Copper", "FC_Style2_Copper", "BNC_TNC", "FC_Coaxial_Headers", "FiberJack", "LC", "MT_RJ", "MU", "SG", "Optical_Pigtail", "HSSDC_II", "Copper_Pigtail", "RJ45", "No_Separable", "MXC_2x16" ], | |
| "x-display_enum_text" : { | |
| "Unknown" : "Unknown", | |
| "SC" : "SC", | |
| "FC_Style1_Copper" : "FC Style1 Copper", | |
| "FC_Style2_Copper" : "FC Style2 Copper", | |
| "BNC_TNC" : "BNC TNC", | |
| "FC_Coaxial_Headers" : "FC Coaxial Headers", | |
| "FiberJack" : "FiberJack", | |
| "LC" : "LC", | |
| "MT_RJ" : "MT RJ", | |
| "MU" : "MU", | |
| "SG" : "SG", | |
| "Optical_Pigtail" : "Optical Pigtail", | |
| "HSSDC_II" : "HSSDC II", | |
| "Copper_Pigtail" : "Copper Pigtail", | |
| "RJ45" : "RJ45", | |
| "No_Separable" : "No Separable", | |
| "MXC_2x16" : "MXC 2x16" | |
| } | |
| }, | |
| "HardwareDriveTypeEnum" : { | |
| "type" : "string", | |
| "description" : "Type of drive. Available on the Drive hardware type. Current types are:\n * Unknown\n * SAS_SSD - SAS-connected SSD in an Expansion Enclosure.\n * NVMe_SCM - NVME-Connected Storage Class Memory.\n * NVMe_NVRAM - NVME-Connected Non-volatile RAM.\n * NVMe_SSD - NVME-Connected SSD.\n", | |
| "enum" : [ "Unknown", "SAS_SSD", "NVMe_SCM", "NVMe_NVRAM", "NVMe_SSD" ], | |
| "x-display_enum_text" : { | |
| "Unknown" : "Unknown", | |
| "SAS_SSD" : "SAS SSD", | |
| "NVMe_SCM" : "NVMe SCM", | |
| "NVMe_NVRAM" : "NVMe NVRAM", | |
| "NVMe_SSD" : "NVMe SSD" | |
| } | |
| }, | |
| "HardwareDriveEncryptionStatusEnum" : { | |
| "type" : "string", | |
| "description" : "Indicates whether the drive is currently encrypted or not. Available on the Drive hardware type. Current statuses are:\n * Not_Supported - Drive does not support encryption.\n * Supported_Unlocked - Drive supports encryption but is not configured.\n * Supported_Locked - Drive supports encryption and is locked.\n * Supported_Locked_Cluster_PIN - Drive supports encryption and is configured.\n * Supported_Locked_Out - Drive supports encryption and is locked out.\n * Supported_Locked_Foreign - Drive supports encryption and is locked with an unknown PIN.\n * Supported_Processing - Drive supports encryption and is being processed.\n * Disabled - Drive encryption is disabled.\n", | |
| "enum" : [ "Not_Supported", "Supported_Unlocked", "Supported_Locked", "Supported_Locked_Cluster_PIN", "Supported_Locked_Out", "Supported_Locked_Foreign", "Supported_Processing", "Disabled" ], | |
| "x-display_enum_text" : { | |
| "Not_Supported" : "Not Supported", | |
| "Supported_Unlocked" : "Supported Unlocked", | |
| "Supported_Locked" : "Supported Locked", | |
| "Supported_Locked_Cluster_PIN" : "Supported Locked Cluster PIN", | |
| "Supported_Locked_Out" : "Supported Locked Out", | |
| "Supported_Locked_Foreign" : "Supported Locked Foreign", | |
| "Supported_Processing" : "Supported Processing", | |
| "Disabled" : "Disabled" | |
| } | |
| }, | |
| "HardwareDriveFIPSStatusEnum" : { | |
| "type" : "string", | |
| "description" : "FIPS compliance level. Available on the Drive hardware type. Current compliance levels are:\n * FIPS_Compliance_None - Drive has no FIPS compliance.\n * FIPS_Compliance_Level_1 - Drive has Level 1 FIPS 140-2 compliance.\n * FIPS_Compliance_Level_2 - Drive has Level 2 FIPS 140-2 compliance.\n * FIPS_Compliance_Invalid - Drive has invalid FIPS compliance.\n", | |
| "enum" : [ "FIPS_Compliance_None", "FIPS_Compliance_Level_1", "FIPS_Compliance_Level_2", "FIPS_Compliance_Invalid" ], | |
| "x-display_enum_text" : { | |
| "FIPS_Compliance_None" : "FIPS Compliance None", | |
| "FIPS_Compliance_Level_1" : "FIPS Compliance Level 1", | |
| "FIPS_Compliance_Level_2" : "FIPS Compliance Level 2", | |
| "FIPS_Compliance_Invalid" : "FIPS Compliance Invalid" | |
| } | |
| }, | |
| "hardware_extra_details_instance" : { | |
| "type" : "object", | |
| "description" : "Additional hardware details that are specific to each hardware type. \nFiltering on the fields of this embedded resource is not supported.", | |
| "properties" : { | |
| "cpu_model" : { | |
| "description" : "CPU model name. Available on Node hardware type.", | |
| "type" : "string" | |
| }, | |
| "physical_memory_size_gb" : { | |
| "description" : "Total amount of physical memory in gigabytes. Available on the Node hardware type.", | |
| "type" : "integer", | |
| "x-units" : "bytes", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "cpu_cores" : { | |
| "description" : "Total number of physical cores. Available on the Node hardware type.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "cpu_sockets" : { | |
| "description" : "Total number of physical sockets. Available on the Node hardware type.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "bus_number" : { | |
| "description" : "Bus number of the Expansion_Shelf. Available on the Expansion_Shelf hardware type.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "enclosure_number" : { | |
| "description" : "Enclosure number of the Expansion_Shelf. Available on the Expansion_Shelf hardware type.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "model_name" : { | |
| "description" : "Model name of the hardware. Available on the IO_Module and M2_Drive hardware types.", | |
| "type" : "string" | |
| }, | |
| "firmware_version" : { | |
| "description" : "Firmware version of the hardware. Available on the Drive hardware type.", | |
| "type" : "string" | |
| }, | |
| "mode" : { | |
| "$ref" : "#/definitions/HardwareSFPModeEnum" | |
| }, | |
| "supported_speeds" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/HardwareSFPSpeedEnum" | |
| } | |
| }, | |
| "supported_protocol" : { | |
| "$ref" : "#/definitions/HardwareSFPSupportedProtocolEnum" | |
| }, | |
| "connector_type" : { | |
| "$ref" : "#/definitions/HardwareSFPConnectorTypeEnum" | |
| }, | |
| "drive_type" : { | |
| "$ref" : "#/definitions/HardwareDriveTypeEnum" | |
| }, | |
| "size" : { | |
| "description" : "Size of the drive in bytes. Available on the Drive hardware type.", | |
| "type" : "integer", | |
| "format" : "int64", | |
| "x-units" : "bytes", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "encryption_status" : { | |
| "$ref" : "#/definitions/HardwareDriveEncryptionStatusEnum" | |
| }, | |
| "fips_status" : { | |
| "$ref" : "#/definitions/HardwareDriveFIPSStatusEnum" | |
| }, | |
| "dell_service_tag" : { | |
| "description" : "Dell service tag of the hardware. Available on the Base_Enclosure and Expansion_Enclosure hardware types.", | |
| "type" : "string" | |
| }, | |
| "express_service_code" : { | |
| "description" : "Express service code of the hardware. Available on the Base_Enclosure and Expansion_Enclosure hardware types.", | |
| "type" : "string" | |
| }, | |
| "mode_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to mode" | |
| }, | |
| "supported_speeds_l10n" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "Localized message array corresponding to supported_speeds" | |
| }, | |
| "supported_protocol_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to supported_protocol" | |
| }, | |
| "connector_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to connector_type" | |
| }, | |
| "drive_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to drive_type" | |
| }, | |
| "encryption_status_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to encryption_status" | |
| }, | |
| "fips_status_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to fips_status" | |
| } | |
| }, | |
| "x-no_filter" : true | |
| }, | |
| "hardware_instance" : { | |
| "type" : "object", | |
| "description" : "Hardware component information.\r\nThis resource type has queriable associations from fc_port, sas_port, eth_port, hardware, appliance", | |
| "x-select_cli" : [ "id", "name", "type", "lifecycle_state", "appliance_id" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "The unique id of the component." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "The name of the component. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "type" : { | |
| "$ref" : "#/definitions/HardwareTypeEnum", | |
| "description" : "Hardware component type." | |
| }, | |
| "lifecycle_state" : { | |
| "$ref" : "#/definitions/HardwareLifecycleStateEnum", | |
| "description" : "Life cycle state of the component." | |
| }, | |
| "parent_id" : { | |
| "type" : "string", | |
| "description" : "The id of the component's parent, or null if this component is at the top of the parent hierarchy." | |
| }, | |
| "appliance_id" : { | |
| "type" : "string", | |
| "description" : "The id of the component's associated appliance." | |
| }, | |
| "slot" : { | |
| "type" : "integer", | |
| "description" : "The slot or location of the component.", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "part_number" : { | |
| "type" : "string", | |
| "description" : "The part number of the component." | |
| }, | |
| "serial_number" : { | |
| "type" : "string", | |
| "description" : "The serial number of the component." | |
| }, | |
| "status_led_state" : { | |
| "$ref" : "#/definitions/HardwareStatusLEDStateEnum", | |
| "description" : "Indicator of the state of the component status LED." | |
| }, | |
| "is_marked" : { | |
| "type" : "boolean", | |
| "description" : "Indicator of whether a component is location marked or not." | |
| }, | |
| "extra_details" : { | |
| "description" : "Additional hardware details. Contents are specific to each component type.", | |
| "$ref" : "#/definitions/hardware_extra_details_instance" | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "lifecycle_state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to lifecycle_state" | |
| }, | |
| "status_led_state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to status_led_state" | |
| }, | |
| "node_fc_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/fc_port_instance", | |
| "x-ref" : "fc_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type fc_port association." | |
| }, | |
| "sfp_fc_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/fc_port_instance", | |
| "x-ref" : "fc_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type fc_port association." | |
| }, | |
| "io_module_fc_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/fc_port_instance", | |
| "x-ref" : "fc_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type fc_port association." | |
| }, | |
| "node_sas_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/sas_port_instance", | |
| "x-ref" : "sas_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type sas_port association." | |
| }, | |
| "sfp_sas_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/sas_port_instance", | |
| "x-ref" : "sas_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type sas_port association." | |
| }, | |
| "io_module_sas_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/sas_port_instance", | |
| "x-ref" : "sas_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type sas_port association." | |
| }, | |
| "node_eth_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/eth_port_instance", | |
| "x-ref" : "eth_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type eth_port association." | |
| }, | |
| "sfp_eth_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/eth_port_instance", | |
| "x-ref" : "eth_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type eth_port association." | |
| }, | |
| "io_module_eth_ports" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/eth_port_instance", | |
| "x-ref" : "eth_port_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type eth_port association." | |
| }, | |
| "parent" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/hardware_instance", | |
| "description" : "This is the embeddable reference form of parent_id attribute.", | |
| "x-ref" : "hardware" | |
| }, | |
| "children" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/hardware_instance", | |
| "x-ref" : "hardware_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type hardware association." | |
| }, | |
| "appliance" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/appliance_instance", | |
| "description" : "This is the embeddable reference form of appliance_id attribute.", | |
| "x-ref" : "appliance" | |
| } | |
| } | |
| }, | |
| "hardware_drive_repurpose" : { | |
| "required" : [ "psid" ], | |
| "properties" : { | |
| "psid" : { | |
| "type" : "string", | |
| "description" : "An alpha-numeric string that can be found on the physical label of the drive to repurpose. This is needed to validate that the user has physical control of the drive before performing the operation." | |
| } | |
| } | |
| }, | |
| "volume_instance" : { | |
| "description" : "Details about a volume, including snapshots and clones of volumes.\r\nThis resource type has queriable associations from appliance, policy, migration_session, host_volume_mapping, volume_group", | |
| "x-select_cli" : [ "id", "name", "type", "wwn", "size", "protection_policy.name" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the volume instance.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "Name of the volume. This value must contain 128 or fewer printable Unicode characters. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "maxLength" : 128, | |
| "x-case-insensitive" : true | |
| }, | |
| "description" : { | |
| "description" : "Description of the volume. This value must contain 128 or fewer printable Unicode characters.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "type" : { | |
| "$ref" : "#/definitions/VolumeTypeEnum" | |
| }, | |
| "wwn" : { | |
| "description" : "World wide name of the volume.", | |
| "type" : "string" | |
| }, | |
| "appliance_id" : { | |
| "description" : "Unique identifier of the appliance on which the volume is provisioned.", | |
| "type" : "string" | |
| }, | |
| "state" : { | |
| "$ref" : "#/definitions/VolumeStateEnum" | |
| }, | |
| "size" : { | |
| "description" : " Size of the volume in bytes. Minimum volume size is 1MB. Maximum volume size is 256TB. Size must be a multiple of 8192.", | |
| "type" : "integer", | |
| "format" : "int64", | |
| "x-units" : "bytes", | |
| "minimum" : 1048576, | |
| "maximum" : 281474976710656 | |
| }, | |
| "node_affinity" : { | |
| "description" : "Node affinity. Node which offers optimized IO for volume, values are:", | |
| "$ref" : "#/definitions/NodeAffinityEnum" | |
| }, | |
| "creation_timestamp" : { | |
| "type" : "string", | |
| "description" : "Time when the volume was created.", | |
| "format" : "date-time" | |
| }, | |
| "protection_policy_id" : { | |
| "description" : "Unique identifier of the protection policy assigned to the volume. Only applicable to primary and clone volumes.", | |
| "type" : "string" | |
| }, | |
| "performance_policy_id" : { | |
| "description" : "Unique identifier of the performance policy assigned to the volume.", | |
| "type" : "string" | |
| }, | |
| "is_replication_destination" : { | |
| "description" : "Indicates whether this volume is a replication destination. A replication destination will be created by the system when a replication session is created. When there is an active replication session, all the user operations are restricted including modification, deletion, host operation, snapshot, clone, etc. After the replication session is deleted, the replication destination volume will remain as it is until the end user changes it to be a non-replication destination. After the change, it becomes a primary volume. If the end user keeps it as a replication destination, when the replication session is recreated, the replication destination volume could potentially be reused in the new session to avoid a time-consuming full sync. This property is only valid for primary and clone volumes.", | |
| "type" : "boolean", | |
| "default" : false | |
| }, | |
| "migration_session_id" : { | |
| "description" : "Unique identifier of the migration session assigned to the volume if it is part of a migration activity.", | |
| "type" : "string" | |
| }, | |
| "protection_data" : { | |
| "$ref" : "#/definitions/protection_data_instance" | |
| }, | |
| "location_history" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/location_history_instance" | |
| }, | |
| "description" : "Filtering on the fields of this embedded resource is not supported.", | |
| "x-no_filter" : true | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to state" | |
| }, | |
| "node_affinity_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to node_affinity" | |
| }, | |
| "appliance" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/appliance_instance", | |
| "description" : "This is the embeddable reference form of appliance_id attribute.", | |
| "x-ref" : "appliance" | |
| }, | |
| "protection_policy" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/policy_instance", | |
| "description" : "This is the embeddable reference form of protection_policy_id attribute.", | |
| "x-ref" : "policy" | |
| }, | |
| "migration_session" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/migration_session_instance", | |
| "description" : "This is the embeddable reference form of migration_session_id attribute.", | |
| "x-ref" : "migration_session" | |
| }, | |
| "mapped_volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/host_volume_mapping_instance", | |
| "x-ref" : "host_volume_mapping_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type host_volume_mapping association." | |
| }, | |
| "volume_groups" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/volume_group_instance", | |
| "x-ref" : "volume_group" | |
| }, | |
| "description" : "List of the volume_groups that are associated with this volume." | |
| } | |
| } | |
| }, | |
| "volume_create" : { | |
| "properties" : { | |
| "name" : { | |
| "description" : "Unique name for the volume to be created. This value must contain 128 or fewer printable Unicode characters.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "size" : { | |
| "description" : "Size of the volume to be created, in bytes. Minimum volume size is 1MB. Maximum volume size is 256TB. Size must be a multiple of 8192.", | |
| "type" : "integer", | |
| "format" : "int64", | |
| "x-units" : "bytes", | |
| "minimum" : 1048576, | |
| "maximum" : 281474976710656 | |
| }, | |
| "host_id" : { | |
| "description" : "Unique identifier of the host to be attached to the volume. If not specified, an unmapped volume is created. Only one of host_id or host_group_id can be supplied.", | |
| "type" : "string" | |
| }, | |
| "host_group_id" : { | |
| "description" : "Unique identifier of the host group to be attached to the volume. If not specified, an unmapped volume is created. Only one of host_id or host_group_id can be supplied.", | |
| "type" : "string" | |
| }, | |
| "logical_unit_number" : { | |
| "description" : "Optional logical unit number when creating a attached volume. If no host_id or host_group_id is specified, this property is ignored.", | |
| "type" : "integer", | |
| "minimum" : 0, | |
| "maximum" : 16383, | |
| "format" : "int32" | |
| }, | |
| "description" : { | |
| "description" : "Description of the volume. This value must contain 128 or fewer printable Unicode characters.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "appliance_id" : { | |
| "description" : "Identifier of the appliance on which the volume is provisioned.", | |
| "type" : "string" | |
| }, | |
| "volume_group_id" : { | |
| "description" : "Volume group to add the volume to. If not specified, the volume is not added to a volume group.", | |
| "type" : "string" | |
| }, | |
| "min_size" : { | |
| "description" : "Optional minimum size for the volume, in bytes.", | |
| "type" : "integer", | |
| "x-units" : "bytes", | |
| "format" : "int64", | |
| "minimum" : 0, | |
| "maximum" : 9223372036854775807 | |
| }, | |
| "sector_size" : { | |
| "description" : "Optional sector size, in bytes. Only 512-byte and 4096-byte sectors are supported.", | |
| "type" : "integer", | |
| "minimum" : 512, | |
| "maximum" : 4096, | |
| "format" : "int32" | |
| }, | |
| "protection_policy_id" : { | |
| "description" : "Unique identifier of the protection policy assigned to the volume.", | |
| "type" : "string" | |
| }, | |
| "performance_policy_id" : { | |
| "description" : "Unique identifier of the performance policy assigned to the volume.", | |
| "type" : "string" | |
| } | |
| }, | |
| "required" : [ "name", "size" ] | |
| }, | |
| "volume_modify" : { | |
| "properties" : { | |
| "name" : { | |
| "description" : "New name of the volume. This value must contain 128 or fewer printable Unicode characters.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "description" : { | |
| "description" : "New description of the volume. This value must contain 128 or fewer printable Unicode characters.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "size" : { | |
| "description" : "New size of the volume in bytes, must be a multiple of 8192, must be bigger than the current volume size. Maximum volume size is 256TB.", | |
| "type" : "integer", | |
| "x-units" : "bytes", | |
| "format" : "int64", | |
| "maximum" : 281474976710656, | |
| "minimum" : 8192 | |
| }, | |
| "expiration_timestamp" : { | |
| "description" : "New expiration time of the snapshot. Expired snapshots are deleted by the snapshot aging service that runs periodically in the background. If not specified, the snapshot never expires.\nUse a maximum timestamp value to set an expiration to never expire.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "protection_policy_id" : { | |
| "description" : "Unique identifier of the protection policy assigned to the volume.", | |
| "type" : "string" | |
| }, | |
| "performance_policy_id" : { | |
| "description" : "Unique identifier of the performance policy assigned to the volume.", | |
| "type" : "string" | |
| }, | |
| "is_replication_destination" : { | |
| "description" : "New value for is_replication_destination property. The modification is only supported for primary and clone volume, only when the current value is true and there is no longer a replication session using this volume as a destination, and only to false.", | |
| "type" : "boolean" | |
| }, | |
| "force" : { | |
| "description" : "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 to be cleaned up.\nWith the force option, the user will be allowed to remove the protection policy from the replication destination volume provided that the replication session has never been synchronized and the last_sync_timestamp property is empty.\nThis parameter defaults to false, if not specified.", | |
| "type" : "boolean", | |
| "default" : false | |
| }, | |
| "node_affinity" : { | |
| "description" : "Set which node will optimized for IO.", | |
| "$ref" : "#/definitions/NodeAffinityEnum" | |
| } | |
| } | |
| }, | |
| "volume_snapshot" : { | |
| "properties" : { | |
| "name" : { | |
| "description" : "Name of the snapshot to be created. This value must contain 128 or fewer printable Unicode characters. The default name of the volume snapshot is the date and time when the snapshot is taken.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "description" : { | |
| "description" : "Description of the snapshot. This value must contain 128 or fewer printable Unicode characters.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "performance_policy_id" : { | |
| "type" : "string" | |
| }, | |
| "expiration_timestamp" : { | |
| "description" : "Expiration time of the snapshot. Expired snapshots are deleted by the snapshot aging service that runs periodically in the background. If not specified, the snapshot never expires.\nUse a maximum timestamp value to set an expiration to never expire.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "creator_type" : { | |
| "$ref" : "#/definitions/StorageCreatorTypeEnum" | |
| } | |
| } | |
| }, | |
| "volume_snapshot_response" : { | |
| "description" : "Unique identifier of the new snapshot volume.", | |
| "properties" : { | |
| "id" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "volume_clone" : { | |
| "properties" : { | |
| "name" : { | |
| "description" : "Name of the clone. This value must contain 128 or fewer printable Unicode characters.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "description" : { | |
| "description" : "Description of the clone. This value must contain 128 or fewer printable Unicode characters.", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "host_id" : { | |
| "description" : "Unique identifier of the host to be attached to the clone. Only one of host_id or host_group_id can be supplied.", | |
| "type" : "string" | |
| }, | |
| "host_group_id" : { | |
| "description" : "Unique identifier of the host group to be attached to the clone. Only one of host_id or host_group_id can be supplied.", | |
| "type" : "string" | |
| }, | |
| "logical_unit_number" : { | |
| "description" : "Optional logical unit number when creating a mapped volume. If no host_id or host_group_id is specified, this property is ignored.", | |
| "type" : "integer", | |
| "minimum" : 0, | |
| "maximum" : 16383, | |
| "format" : "int32" | |
| }, | |
| "performance_policy_id" : { | |
| "description" : "Unique identifier of the performance policy.", | |
| "type" : "string" | |
| }, | |
| "protection_policy_id" : { | |
| "description" : "Unique identifier of the protection policy.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "volume_clone_response" : { | |
| "description" : "Unique identifier of the new clone volume.", | |
| "properties" : { | |
| "id" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "volume_refresh" : { | |
| "properties" : { | |
| "from_object_id" : { | |
| "description" : "Unique identifier of the source object of the refresh operation. The refresh operation only refreshes the data.", | |
| "type" : "string" | |
| }, | |
| "create_backup_snap" : { | |
| "description" : "Indicates whether to create a backup snapshot of the volume before refreshing.", | |
| "default" : false, | |
| "type" : "boolean" | |
| }, | |
| "backup_snap_profile" : { | |
| "description" : "Profile for the backup snapshot.", | |
| "$ref" : "#/definitions/volume_snapshot" | |
| } | |
| }, | |
| "required" : [ "from_object_id" ] | |
| }, | |
| "volume_refresh_response" : { | |
| "description" : "Unique identifier of the backup snapshot if one is created.", | |
| "properties" : { | |
| "backup_snapshot_id" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "volume_restore" : { | |
| "properties" : { | |
| "from_snap_id" : { | |
| "description" : "Unique identifier of the source snapshot for the restore operation.", | |
| "type" : "string" | |
| }, | |
| "create_backup_snap" : { | |
| "description" : "Indicates whether to create a backup snapshot of the volume before restoring.", | |
| "default" : true, | |
| "type" : "boolean" | |
| }, | |
| "backup_snap_profile" : { | |
| "description" : "Profile for the backup snapshot.", | |
| "$ref" : "#/definitions/volume_snapshot" | |
| } | |
| }, | |
| "required" : [ "from_snap_id" ] | |
| }, | |
| "volume_restore_response" : { | |
| "description" : "Unique identifier of the backup snapshot if one is created.", | |
| "properties" : { | |
| "backup_snapshot_id" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "volume_attach" : { | |
| "properties" : { | |
| "host_id" : { | |
| "description" : "Unique identifier of the host to be attached to the volume. Only one of host_id or host_group_id can be supplied.", | |
| "type" : "string" | |
| }, | |
| "host_group_id" : { | |
| "description" : "Unique identifier of the host group to be attached to the volume. Only one of host_id or host_group_id can be supplied.", | |
| "type" : "string" | |
| }, | |
| "logical_unit_number" : { | |
| "description" : "Logical unit number for the host volume access.", | |
| "type" : "integer", | |
| "minimum" : 0, | |
| "maximum" : 16383, | |
| "format" : "int32" | |
| } | |
| } | |
| }, | |
| "volume_detach" : { | |
| "properties" : { | |
| "host_id" : { | |
| "description" : "Unique identifier of the host to be detached from this volume. Only one of host_id or host_group_id can be supplied.", | |
| "type" : "string" | |
| }, | |
| "host_group_id" : { | |
| "description" : "Unique identifier of the host group to be detached from this volume. Only one of host_id or host_group_id can be supplied.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "host_volume_mapping_instance" : { | |
| "description" : "Details about a configured host or host group attached to a volume. The host or host group may not necessarily be connected.\r\nThis resource type has queriable associations from host, host_group, volume", | |
| "x-select_cli" : [ "id", "logical_unit_number", "host.name", "host_group.name", "volume.name" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of a mapping between a host and a volume.", | |
| "type" : "string" | |
| }, | |
| "host_id" : { | |
| "description" : "Unique identifier of a host attached to a volume. The host_id and host_group_id cannot both be set.", | |
| "type" : "string" | |
| }, | |
| "host_group_id" : { | |
| "description" : "Unique identifier of a host group attached to a volume. The host_id and host_group_id cannot both be set.", | |
| "type" : "string" | |
| }, | |
| "volume_id" : { | |
| "description" : "Unique identifier of the volume to which the host is attached.", | |
| "type" : "string" | |
| }, | |
| "logical_unit_number" : { | |
| "description" : "Logical unit number for the host volume access.", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "host" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/host_instance", | |
| "description" : "This is the embeddable reference form of host_id attribute.", | |
| "x-ref" : "host" | |
| }, | |
| "host_group" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/host_group_instance", | |
| "description" : "This is the embeddable reference form of host_group_id attribute.", | |
| "x-ref" : "host_group" | |
| }, | |
| "volume" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/volume_instance", | |
| "description" : "This is the embeddable reference form of volume_id attribute.", | |
| "x-ref" : "volume" | |
| } | |
| } | |
| }, | |
| "discovered_initiator_instance" : { | |
| "description" : "An initiator currently connected to the cluster, but not associated with any host.", | |
| "x-select_cli" : [ "name", "protocol_type" ], | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "IQN or WWN of the initiator" | |
| }, | |
| "protocol_type" : { | |
| "type" : "string", | |
| "$ref" : "#/definitions/InitiatorProtocolTypeEnum" | |
| }, | |
| "protocol_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to protocol_type" | |
| } | |
| } | |
| }, | |
| "performance_metrics_by_file_system" : { | |
| "title" : "sdnas_file_system_metrics_instance", | |
| "type" : "object", | |
| "description" : "Performance metrics for the file system collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_file_system" | |
| } ] | |
| }, | |
| "performance_metrics_by_file_system_rollup" : { | |
| "title" : "sdnas_file_system_metrics_rollup", | |
| "type" : "object", | |
| "description" : "Summary of file system level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_file_system_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_nfs" : { | |
| "title" : "sdnas_nfs_metrics_instance", | |
| "type" : "object", | |
| "description" : "Performance metrics for the nfs collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_nfs" | |
| } ] | |
| }, | |
| "performance_metrics_by_nfs_rollup" : { | |
| "title" : "sdnas_nfs_metrics_rollup", | |
| "type" : "object", | |
| "description" : "Summary of nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_nfs_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_nfsv3" : { | |
| "title" : "sdnas_nfs3_metrics_instance", | |
| "type" : "object", | |
| "description" : "Performance metrics for the nfs collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_nfsv3" | |
| } ] | |
| }, | |
| "performance_metrics_by_nfsv3_rollup" : { | |
| "title" : "sdnas_nfs3_metrics_rollup", | |
| "type" : "object", | |
| "description" : "Summary of nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_nfsv3_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_nfsv4" : { | |
| "title" : "sdnas_nfs4_metrics_instance", | |
| "type" : "object", | |
| "description" : "Performance metrics for the nfs collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_nfsv4" | |
| } ] | |
| }, | |
| "performance_metrics_by_nfsv4_rollup" : { | |
| "title" : "sdnas_nfs3_metrics_rollup", | |
| "type" : "object", | |
| "description" : "Summary of nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_nfsv4_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_cache" : { | |
| "title" : "sdnas_smb_cache_metrics_instance", | |
| "type" : "object", | |
| "description" : "Performance metrics for the smb cache collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_cache" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_cache_rollup" : { | |
| "title" : "sdnas_smb_cache_metrics_rollup", | |
| "type" : "object", | |
| "description" : "Performance metrics nfs level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_cache_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_client" : { | |
| "title" : "sdnas_smb_client_metrics_instance", | |
| "type" : "object", | |
| "description" : "Performance metrics for the smb client collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_client" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_client_rollup" : { | |
| "title" : "sdnas_smb_client_metrics_rollup", | |
| "type" : "object", | |
| "description" : "Summary of smb client level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_client_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_node" : { | |
| "title" : "sdnas_smb_node_metrics_instance", | |
| "type" : "object", | |
| "description" : "Performance metrics for the smb node collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_node" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_node_rollup" : { | |
| "title" : "sdnas_smb_node_metrics_rollup", | |
| "type" : "object", | |
| "description" : "Summary of smb node level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_node_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_v1_builtin_client" : { | |
| "title" : "sdnas_smb_v1_client_metrics_instance", | |
| "type" : "object", | |
| "description" : "Performance metrics for the smb v1 client collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_v1_builtin_client" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_v1_builtin_client_rollup" : { | |
| "title" : "sdnas_smb_v1_client_metrics_rollup", | |
| "type" : "object", | |
| "description" : "Summary of smb v1 client level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_v1_builtin_client_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_v1_node" : { | |
| "title" : "sdnas_smb_v1_node_metrics_instance", | |
| "type" : "object", | |
| "description" : "Performance metrics for the smb v1 node collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_v1_node" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_v1_node_rollup" : { | |
| "title" : "sdnas_smb_v1_node_metrics_rollup", | |
| "type" : "object", | |
| "description" : "Summary of smb v1 node level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_v1_node_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_v2_builtin_client" : { | |
| "title" : "sdnas_smb_v2_client_metrics_instance", | |
| "type" : "object", | |
| "description" : "Performance metrics for the smb v1 client collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_v2_builtin_client" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_v2_builtin_client_rollup" : { | |
| "title" : "sdnas_smb_v2_client_metrics_rollup", | |
| "type" : "object", | |
| "description" : "Summary of smb v1 client level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_v2_builtin_client_rollup" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_v2_node" : { | |
| "title" : "sdnas_smb_v2_node_metrics_instance", | |
| "type" : "object", | |
| "description" : "Performance metrics for the smb v1 node collected at twenty second interval.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_v2_node" | |
| } ] | |
| }, | |
| "performance_metrics_by_smb_v2_node_rollup" : { | |
| "title" : "sdnas_smb_v2_node_metrics_rollup", | |
| "type" : "object", | |
| "description" : "Summary of smb v1 node level performance metric data for the period beginning with timestamp, including the average and maximum values for that period.", | |
| "allOf" : [ { | |
| "$ref" : "#/definitions/metrics_generate_response" | |
| }, { | |
| "$ref" : "#/definitions/base_performance_metrics_by_smb_v2_node_rollup" | |
| } ] | |
| }, | |
| "remote_system_instance" : { | |
| "title" : "remote_system_instance", | |
| "description" : "A remote system.\n\r\nThis resource type has queriable associations from import_session, replication_session", | |
| "x-select_cli" : [ "id", "name", "management_address", "type", "state", "data_connection_state" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the remote system instance.\n", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "User-specified name of the remote system instance.\n \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "description" : { | |
| "description" : "User-specified description of the remote system instance.\n", | |
| "type" : "string" | |
| }, | |
| "serial_number" : { | |
| "description" : "Serial number of the remote system instance.\n", | |
| "type" : "string" | |
| }, | |
| "management_address" : { | |
| "description" : "Management IP address of the remote system instance.\n", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "type" : { | |
| "description" : "Type of the remote system.\n", | |
| "$ref" : "#/definitions/RemoteSystemTypeEnum" | |
| }, | |
| "user_name" : { | |
| "description" : "Username used to access the non-PowerStore remote systems. \n", | |
| "type" : "string" | |
| }, | |
| "state" : { | |
| "description" : "Current state of the remote system.\n", | |
| "$ref" : "#/definitions/RemoteSystemStateEnum" | |
| }, | |
| "data_connection_state" : { | |
| "description" : "State of the data connection.\n", | |
| "$ref" : "#/definitions/DataConnectionStateEnum" | |
| }, | |
| "iscsi_addresses" : { | |
| "description" : "iSCSI target addresses for the data connection to the remote system.\n", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "format" : "ip-address" | |
| } | |
| }, | |
| "discovery_chap_mode" : { | |
| "description" : "Discovery chap mode for the non-PowerStore remote system.\n", | |
| "$ref" : "#/definitions/RemoteSystemChapModeEnum" | |
| }, | |
| "session_chap_mode" : { | |
| "description" : "Session chap mode for the non-PowerStore remote system.\n", | |
| "$ref" : "#/definitions/RemoteSystemChapModeEnum" | |
| }, | |
| "data_network_latency" : { | |
| "description" : "Network latency for the remote system.\n", | |
| "$ref" : "#/definitions/RemoteSystemLatencyEnum" | |
| }, | |
| "data_connections" : { | |
| "type" : "array", | |
| "description" : "List of data connections from each appliance in the local cluster to iSCSI target IP address.\n \nFiltering on the fields of this embedded resource is not supported.", | |
| "items" : { | |
| "$ref" : "#/definitions/data_connection_instance" | |
| }, | |
| "x-no_filter" : true | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to state" | |
| }, | |
| "data_connection_state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to data_connection_state" | |
| }, | |
| "discovery_chap_mode_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to discovery_chap_mode" | |
| }, | |
| "session_chap_mode_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to session_chap_mode" | |
| }, | |
| "data_network_latency_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to data_network_latency" | |
| }, | |
| "import_sessions" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/import_session_instance", | |
| "x-ref" : "import_session_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type import_session association." | |
| }, | |
| "replication_sessions" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/replication_session_instance", | |
| "x-ref" : "replication_session_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type replication_session association." | |
| } | |
| } | |
| }, | |
| "data_connection_instance" : { | |
| "type" : "object", | |
| "description" : "Data connection status between the local node and a remote target. \n", | |
| "properties" : { | |
| "node_id" : { | |
| "description" : "Unique identifier of the local, initiating node.\n", | |
| "type" : "string" | |
| }, | |
| "initiator_address" : { | |
| "description" : "Initiating address from the local node.\n", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "target_address" : { | |
| "description" : "Target address from the remote system.\n", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "status" : { | |
| "description" : "Status of the data connection.\n", | |
| "$ref" : "#/definitions/TransitConnectionStatusEnum" | |
| }, | |
| "status_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to status" | |
| } | |
| } | |
| }, | |
| "remote_system_create" : { | |
| "type" : "object", | |
| "description" : "Create a remote system.\nFor a PowerStore remote system, an x509 Replication HTTP Certificate is a prerequisite.\nRefer to the x509_certificate resource type's exchange operation API documentation.\n", | |
| "required" : [ "management_address" ], | |
| "properties" : { | |
| "management_address" : { | |
| "description" : "Management IP address of the remote system instance. Only IPv4 is supported for non-PowerStore remote systems.\nBoth IPv4 and IPv6 are supported for PowerStore remote systems.\n", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "name" : { | |
| "description" : "User-specified name of the remote system. Used only for non-PowerStore systems. This value must contain 128 or fewer printable Unicode characters.\n", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "description" : { | |
| "description" : "User-specified description of the remote system.\n", | |
| "type" : "string", | |
| "maxLength" : 256 | |
| }, | |
| "type" : { | |
| "description" : "Type of remote system.\n", | |
| "$ref" : "#/definitions/RemoteSystemTypeEnum" | |
| }, | |
| "remote_username" : { | |
| "description" : "Username used to access the remote system. Used only for non-PowerStore systems.\n", | |
| "type" : "string" | |
| }, | |
| "remote_password" : { | |
| "description" : "Password used to access the remote system. Used only for non-PowerStore systems.\n", | |
| "type" : "string", | |
| "format" : "password" | |
| }, | |
| "iscsi_addresses" : { | |
| "description" : "iSCSI target IP addresses for the data connection to the remote system. Must be specified when creating a non-PowerStore remote system.\n", | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "format" : "ip-address" | |
| } | |
| }, | |
| "import_chap_info" : { | |
| "description" : "Chap information to be used for session and discovery. This is applicable to non-PowerStore remote systems.\n", | |
| "$ref" : "#/definitions/chap_credentials_instance" | |
| }, | |
| "discovery_chap_mode" : { | |
| "description" : "Indicates the chap mode to be used during discovery. This is applicable to non-PowerStore remote systems.\n", | |
| "$ref" : "#/definitions/RemoteSystemChapModeEnum" | |
| }, | |
| "session_chap_mode" : { | |
| "description" : "Indicates the chap mode to be used for session. This is applicable to non-PowerStore remote systems.\n", | |
| "$ref" : "#/definitions/RemoteSystemChapModeEnum" | |
| }, | |
| "data_network_latency" : { | |
| "description" : "Network latency choices for remote system. This is applicable to PowerStore remote systems.\n", | |
| "$ref" : "#/definitions/RemoteSystemLatencyEnum" | |
| } | |
| } | |
| }, | |
| "remote_system_verify" : { | |
| "type" : "object", | |
| "description" : "Verify the remote system.\n", | |
| "properties" : { } | |
| }, | |
| "remote_system_delete" : { | |
| "type" : "object", | |
| "description" : "Delete a remote system and any associated x509 Replication HTTP certificates.\n", | |
| "properties" : { } | |
| }, | |
| "remote_system_modify" : { | |
| "type" : "object", | |
| "description" : "Modify the remote system.\n", | |
| "properties" : { | |
| "name" : { | |
| "description" : "User-specified name of the remote system. Used only for non-PowerStore type remote systems. This value must contain 128 or fewer printable Unicode characters.\n", | |
| "type" : "string", | |
| "maxLength" : 128 | |
| }, | |
| "description" : { | |
| "description" : "User-specified description of the remote system.\n", | |
| "type" : "string", | |
| "maxLength" : 256 | |
| }, | |
| "management_address" : { | |
| "description" : "Management IP address of the remote system.\n", | |
| "type" : "string", | |
| "format" : "ip-address" | |
| }, | |
| "remote_username" : { | |
| "description" : "Username used to access the remote system. Used only for non-PowerStore systems.\n", | |
| "type" : "string" | |
| }, | |
| "remote_password" : { | |
| "description" : "Password used to access the remote system. Used only for non-PowerStore systems.\n", | |
| "type" : "string", | |
| "format" : "password" | |
| }, | |
| "data_network_latency" : { | |
| "description" : "Network latency for the PowerStore remote system.\n", | |
| "$ref" : "#/definitions/RemoteSystemLatencyEnum" | |
| } | |
| } | |
| }, | |
| "chap_credentials_instance" : { | |
| "description" : "Information about the initiator, target session, or discovery CHAP secrets.\n", | |
| "type" : "object", | |
| "properties" : { | |
| "target_session_username" : { | |
| "description" : "Username used by the target to authenticate the initiator during session authentication. Single CHAP mode only.\n", | |
| "type" : "string" | |
| }, | |
| "target_session_password" : { | |
| "description" : "Password used by the target to authenticate the initiator during session authentication. Single CHAP mode only.\n", | |
| "type" : "string", | |
| "format" : "password" | |
| }, | |
| "target_discovery_username" : { | |
| "description" : "Username used by the target to authenticate the initiator during discovery authentication. Single CHAP mode only.\n", | |
| "type" : "string" | |
| }, | |
| "target_discovery_password" : { | |
| "description" : "Password used by the target to authenticate the initiator during discovery authentication. Single CHAP mode only.\n", | |
| "type" : "string", | |
| "format" : "password" | |
| }, | |
| "initiator_session_username" : { | |
| "description" : "Username used by the initiator to authenticate the target during session authentication. Mutual CHAP mode only.\n", | |
| "type" : "string" | |
| }, | |
| "initiator_session_password" : { | |
| "description" : "Password used by the initiator to authenticate the target during session authentication. Mutual CHAP mode only.\n", | |
| "type" : "string", | |
| "format" : "password" | |
| }, | |
| "initiator_discovery_username" : { | |
| "description" : "Username used by the initiator to authenticate the target during discovery authentication. Mutual CHAP mode only.\n", | |
| "type" : "string" | |
| }, | |
| "initiator_discovery_password" : { | |
| "description" : "Password used by the initiator to authenticate the target during discovery authentication. Mutual CHAP mode only.\n", | |
| "type" : "string", | |
| "format" : "password" | |
| } | |
| } | |
| }, | |
| "RemoteSystemTypeEnum" : { | |
| "description" : "Remote system connection type between the local system and the following remote systems: \n* PowerStore - PowerStore system\n* Unity - Unity import system\n* VNX - VNX import system\n* PS_Equallogic - PS EqualLogic import system\n* Storage_Center - Storage Center import system\n* XtremIO - XtremIO import system\n", | |
| "type" : "string", | |
| "enum" : [ "PowerStore", "Unity", "VNX", "PS_Equallogic", "Storage_Center", "XtremIO" ], | |
| "x-display_enum_text" : { | |
| "PowerStore" : "PowerStore", | |
| "Unity" : "Unity", | |
| "VNX" : "VNX", | |
| "PS_Equallogic" : "PS Equallogic", | |
| "Storage_Center" : "Storage Center", | |
| "XtremIO" : "XtremIO" | |
| } | |
| }, | |
| "RemoteSystemStateEnum" : { | |
| "description" : "Possible remote system states: \n* OK - Normal conditions.\n* Update_Needed - Verify and update needed to handle network configuration changes on the systems.\n* Management_Connection_Lost - Management connection to the remote peer is lost.\n", | |
| "type" : "string", | |
| "enum" : [ "OK", "Update_Needed", "Management_Connection_Lost" ], | |
| "x-display_enum_text" : { | |
| "OK" : "OK", | |
| "Update_Needed" : "Update Needed", | |
| "Management_Connection_Lost" : "Management Connection Lost" | |
| } | |
| }, | |
| "DataConnectionStateEnum" : { | |
| "description" : "Possible data connection states of a remote system:\n* OK - Normal conditions.\n* Partial_Data_Connection_Loss - Partial data connection loss.\n* Complete_Data_Connection_Loss - Complete data connection loss.\n* Status_Not_Available - Status not available.\n* No_Targets_Discovered - No targets discovered.\n* Initializing - Initializing\n", | |
| "type" : "string", | |
| "enum" : [ "OK", "Partial_Data_Connection_Loss", "Complete_Data_Connection_Loss", "Status_Not_Available", "No_Targets_Discovered", "Initializing" ], | |
| "x-display_enum_text" : { | |
| "OK" : "OK", | |
| "Partial_Data_Connection_Loss" : "Partial Data Connections Loss", | |
| "Complete_Data_Connection_Loss" : "Complete Data Connections Loss", | |
| "Status_Not_Available" : "Status Not Available", | |
| "No_Targets_Discovered" : "No Targets Discovered", | |
| "Initializing" : "Initializing" | |
| } | |
| }, | |
| "RemoteSystemChapModeEnum" : { | |
| "description" : "Challenge Handshake Authentication Protocol (CHAP) status:\n* Disabled \n* Single - Enabled for initiator authentication.\n* Mutual - Enabled for initiator and target authentication.\n", | |
| "type" : "string", | |
| "enum" : [ "Disabled", "Single", "Mutual" ], | |
| "x-display_enum_text" : { | |
| "Disabled" : "Disabled", | |
| "Single" : "Single", | |
| "Mutual" : "Mutual" | |
| } | |
| }, | |
| "RemoteSystemLatencyEnum" : { | |
| "description" : "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.\n* Low - Less than 5 milliseconds.\n* High - More than 5 milliseconds.\n", | |
| "type" : "string", | |
| "enum" : [ "Low", "High" ], | |
| "x-display_enum_text" : { | |
| "Low" : "Low", | |
| "High" : "High" | |
| } | |
| }, | |
| "TransitConnectionStatusEnum" : { | |
| "description" : "Possible transit connection statuses:\n* Login_Success - Login to target IP successful.\n* Authentication_Failure - Failed to authenticate the connection.\n* Connection_Refused - Connection was refused.\n* Login_Timeout - Login to target IP timed out.\n* Network_Error - Network error\n* General_Failure - Other failure not listed.\n* Login_Success_No_Ports - Login successful after discovery failure. Used only for PS EqualLogic systems.\n* Discovery_Success - Discovery of target IP successful.\n* Discovery_Authentication_Failure - Authentication failure during discovery of target IP.\n* Discovery_Connection_Refused - Connection was refused during discovery of target IP.\n* Discovery_Timeout - Discovery of target IP timed out.\n", | |
| "type" : "string", | |
| "enum" : [ "Login_Success", "Authentication_Failure", "Connection_Refused", "Login_Timeout", "Network_Error", "General_Failure", "Login_Success_No_Ports", "Discovery_Success", "Discovery_Authentication_Failure", "Discovery_Connection_Refused", "Discovery_Timeout" ], | |
| "x-display_enum_text" : { | |
| "Login_Success" : "Login Successful", | |
| "Authentication_Failure" : "Authentication Failure", | |
| "Connection_Refused" : "Connection Refused", | |
| "Network_Error" : "Network Error", | |
| "Login_Timeout" : "Login Timeout", | |
| "General_Failure" : "General Failure", | |
| "Login_Success_No_Ports" : "Login Successful No Ports Discovered", | |
| "Discovery_Success" : "Discovery Success", | |
| "Discovery_Authentication_Failure" : "Discovery Authentication Failure", | |
| "Discovery_Connection_Refused" : "Discovery Connection Failure", | |
| "Discovery_Timeout" : "Discovery Timeout" | |
| } | |
| }, | |
| "replication_session_instance" : { | |
| "description" : "A replication session.\n\r\nThis resource type has queriable associations from remote_system, migration_session, replication_rule", | |
| "x-select_cli" : [ "id", "last_sync_timestamp", "local_resource_id", "remote_resource_id", "progress_percentage" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the replication session instance.\n", | |
| "type" : "string" | |
| }, | |
| "state" : { | |
| "description" : "Current state of the replication session.\n", | |
| "$ref" : "#/definitions/ReplicationStateEnum" | |
| }, | |
| "role" : { | |
| "description" : "Role of the replication session.\n", | |
| "$ref" : "#/definitions/ReplicationRoleEnum" | |
| }, | |
| "resource_type" : { | |
| "description" : "Type of the storage resource.\n", | |
| "$ref" : "#/definitions/ReplicatedResourceTypeEnum" | |
| }, | |
| "last_sync_timestamp" : { | |
| "description" : "Time of last successful synchronization.\n", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "local_resource_id" : { | |
| "description" : "Unique identifier of the local storage resource for the replication session.\n", | |
| "type" : "string" | |
| }, | |
| "remote_resource_id" : { | |
| "description" : "Unique identifier of the remote storage resource for the replication session.\n", | |
| "type" : "string" | |
| }, | |
| "remote_system_id" : { | |
| "description" : "Unique identifier of the remote system instance.\n", | |
| "type" : "string" | |
| }, | |
| "progress_percentage" : { | |
| "description" : "Progress of the current replication operation.\n", | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "estimated_completion_timestamp" : { | |
| "description" : "Estimated completion time of the current replication operation.\n", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "replication_rule_id" : { | |
| "description" : "Associated replication rule instance if created by policy engine. \n", | |
| "type" : "string" | |
| }, | |
| "storage_element_pairs" : { | |
| "type" : "array", | |
| "description" : "List of storage element pairs for a replication session. For a volume or volume group replication session, the replicating storage elements are of type 'volume’. For a virtual volume replication session, the replicating storage elements are of type 'virtual volume’. For a volume group replication session, there will be as many pairs of storage elements as the number of volumes in the volume group. For volume/virtual volume replication session, there will be only one storage element pair.\n \nFiltering on the fields of this embedded resource is not supported.", | |
| "items" : { | |
| "$ref" : "#/definitions/replication_element_pair" | |
| }, | |
| "x-no_filter" : true | |
| }, | |
| "state_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to state" | |
| }, | |
| "role_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to role" | |
| }, | |
| "resource_type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to resource_type" | |
| }, | |
| "remote_system" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/remote_system_instance", | |
| "description" : "This is the embeddable reference form of remote_system_id attribute.", | |
| "x-ref" : "remote_system" | |
| }, | |
| "migration_session" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/migration_session_instance", | |
| "description" : "This is the embeddable reference form of migration_session_id attribute.", | |
| "x-ref" : "migration_session" | |
| }, | |
| "replication_rule" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/replication_rule_instance", | |
| "description" : "This is the embeddable reference form of replication_rule_id attribute.", | |
| "x-ref" : "replication_rule" | |
| } | |
| } | |
| }, | |
| "replication_session_failover" : { | |
| "type" : "object", | |
| "description" : "Parameters to fail over a replication session.\n", | |
| "properties" : { | |
| "is_planned" : { | |
| "description" : "Indicates whether the replication session failover is planned or unplanned. For planned failovers, the value is true. For unplanned failovers, the value is false.\n", | |
| "type" : "boolean", | |
| "default" : true | |
| }, | |
| "reverse" : { | |
| "description" : "Indicates whether the system is auto-reprotected. Auto-reprotect is combination of failover and reprotect. \n", | |
| "type" : "boolean", | |
| "default" : false | |
| }, | |
| "force" : { | |
| "description" : "Indicates whether an unplanned failover needs to be done for a session that is already in failed over state\n", | |
| "type" : "boolean", | |
| "default" : false | |
| } | |
| } | |
| }, | |
| "replication_element_pair" : { | |
| "description" : "Replication session element pair which maps the local storage element to the remote storage element.\n", | |
| "type" : "object", | |
| "required" : [ "local_storage_element_id", "remote_storage_element_id" ], | |
| "properties" : { | |
| "local_storage_element_id" : { | |
| "description" : "Unique identifier of a local storage element.\n", | |
| "type" : "string" | |
| }, | |
| "remote_storage_element_id" : { | |
| "description" : "Unique identifier of a remote storage element.\n", | |
| "type" : "string" | |
| }, | |
| "storage_element_type" : { | |
| "description" : "Storage element type.\n", | |
| "$ref" : "#/definitions/StorageElementTypeEnum" | |
| }, | |
| "replication_shadow_id" : { | |
| "description" : "Unique identifier of the internal snap used for replicating data.\n", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ReplicatedResourceTypeEnum" : { | |
| "description" : "Storage resource types eligible for replication protection:\n* volume - Replication session created on a volume. * volume_group - Replication session created on a volume group.", | |
| "type" : "string", | |
| "enum" : [ "volume", "volume_group" ], | |
| "x-display_enum_text" : { | |
| "volume" : "Volume", | |
| "volume_group" : "Volume Group" | |
| } | |
| }, | |
| "StorageElementTypeEnum" : { | |
| "description" : "Storage element type being replicated:\n* volume - Replicating storage element type for a volume.\n* virtual_volume - Replicating storage element type for a virtual volume.\n", | |
| "type" : "string", | |
| "enum" : [ "volume", "virtual_volume" ], | |
| "x-display_enum_text" : { | |
| "volume" : "Volume", | |
| "virtual_volume" : "Virtual Volume" | |
| } | |
| }, | |
| "ReplicationRoleEnum" : { | |
| "description" : "Role of the replication session:\n* Source - The local resource is the source of the remote replication session. * Destination - The local resource is the destination of the remote replication session.", | |
| "type" : "string", | |
| "enum" : [ "Source", "Destination" ], | |
| "x-display_enum_text" : { | |
| "Source" : "Source", | |
| "Destination" : "Destination" | |
| } | |
| }, | |
| "ReplicationStateEnum" : { | |
| "description" : "State of the replication session:\n* Initializing - The replication session is being created. The status changes to OK after the replication session is created.\n* OK - No other operation. The replication session is operating normally.\n* Synchronizing - The replication session has started either a manual or automatic synchronization.\n* System_Paused - Replication session operation has failed or was cancelled. User intervention required.\n* Paused - User paused the replication session.\n* Paused_For_Migration - Migration paused the replication session.\n* Paused_For_NDU - A non-disruptive upgrade paused the replication session.\n* Resuming - The replication session is resuming operation. The status changes to OK after the replication session is resumed.\n* Failing_Over - A planned failover is in progress. The status changes to Failed_Over after the replication session has failed over.\n* Failing_Over_For_DR - An unplanned failover is in progress. The status changes to Failed_Over after the replication session has failed over.\n* Failed_Over - The replication session underwent a planned or unplanned failover. User intervention required.\n* Reprotecting - The replication session is being reprotected. The status changes to OK after the replication session has been reprotected.\n* Partial_Cutover_For_Migration - Replication session created by internal migration has partially migrated the storage resource.\n* Error - Any other failure not specified.", | |
| "type" : "string", | |
| "enum" : [ "Initializing", "OK", "Synchronizing", "System_Paused", "Paused", "Paused_For_Migration", "Paused_For_NDU", "Resuming", "Failing_Over", "Failing_Over_For_DR", "Failed_Over", "Reprotecting" ], | |
| "x-display_enum_text" : { | |
| "Initializing" : "Initializing", | |
| "OK" : "OK", | |
| "Synchronizing" : "Synchronizing", | |
| "System_Paused" : "System Paused", | |
| "Paused" : "Paused", | |
| "Paused_For_Migration" : "Paused For Migration", | |
| "Paused_For_NDU" : "Paused For NDU", | |
| "Resuming" : "Resuming", | |
| "Failing_Over" : "Failing Over", | |
| "Failing_Over_For_DR" : "Failing Over For DR", | |
| "Failed_Over" : "Failed Over", | |
| "Reprotecting" : "Reprotecting" | |
| } | |
| }, | |
| "vcenter_instance" : { | |
| "type" : "object", | |
| "description" : "Properties of a vCenter.", | |
| "x-select_cli" : [ "id", "instance_uuid", "address", "username" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the vCenter instance." | |
| }, | |
| "instance_uuid" : { | |
| "type" : "string", | |
| "description" : "UUID instance of the vCenter." | |
| }, | |
| "address" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "description" : "IP address of vCenter host, in IPv4, IPv6, or hostname format." | |
| }, | |
| "username" : { | |
| "type" : "string", | |
| "description" : "User name to login to vCenter." | |
| } | |
| } | |
| }, | |
| "vcenter_create" : { | |
| "type" : "object", | |
| "properties" : { | |
| "address" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "description" : "IP address of vCenter host, in IPv4, IPv6, or hostname format." | |
| }, | |
| "username" : { | |
| "type" : "string", | |
| "description" : "User name to login to vCenter." | |
| }, | |
| "password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "Password to login to vCenter." | |
| } | |
| } | |
| }, | |
| "vcenter_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "address" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "description" : "IP address of vCenter host, in IPv4, IPv6, or hostname format. Must be a new address of the same vCenter." | |
| }, | |
| "username" : { | |
| "type" : "string", | |
| "description" : "User name to login to vCenter. Password needs to be provided to modify the user name." | |
| }, | |
| "password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "Password to login to vCenter." | |
| } | |
| } | |
| }, | |
| "VGPlacementRule" : { | |
| "description" : "This is set during creation, and determines resource balancer recommendations.\n* Same_Appliance - All the members of the group should be on the same appliance in the cluster.\n* No_Preference - The volumes can be placed on any of the appliances in the cluster.\n \nFiltering on the fields of this embedded resource is not supported.", | |
| "type" : "string", | |
| "enum" : [ "Same_Appliance", "No_Preference" ], | |
| "x-display_enum_text" : { | |
| "Same_Appliance" : "Same Appliance", | |
| "No_Preference" : "No Preference" | |
| }, | |
| "x-no_filter" : true | |
| }, | |
| "volume_group_instance" : { | |
| "description" : "Information about a volume group.\r\nThis resource type has queriable associations from policy, migration_session, volume", | |
| "x-select_cli" : [ "id", "name", "description", "protection_policy_id", "is_write_order_consistent", "type" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the volume group.", | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "description" : "Name of the volume group. \nThis property supports case-insensitive filtering", | |
| "type" : "string", | |
| "x-case-insensitive" : true | |
| }, | |
| "description" : { | |
| "description" : "Description for the volume group.", | |
| "type" : "string" | |
| }, | |
| "creation_timestamp" : { | |
| "description" : "The time at which the volume group was created.", | |
| "type" : "string", | |
| "format" : "date-time" | |
| }, | |
| "is_protectable" : { | |
| "description" : "This is a derived field that is set internally. It enables/disables the following functionality:\n* Whether a protection_policy can be applied to the group.\n* Whether manual snapshots can be taken.\n* Whether clones of the group can be created.\n", | |
| "type" : "boolean" | |
| }, | |
| "protection_policy_id" : { | |
| "description" : "Unique identifier of the protection policy assigned to the volume group. This attribute is only applicable to primary and clone volume groups.", | |
| "type" : "string" | |
| }, | |
| "migration_session_id" : { | |
| "description" : "Unique identifier of the migration session assigned to the volume group when it is part of a migration activity.", | |
| "type" : "string" | |
| }, | |
| "is_write_order_consistent" : { | |
| "type" : "boolean", | |
| "description" : "For a primary or a clone volume group, this property determines whether snapshot sets of the group will be write order consistent.\n\nFor a snapshot set, this property indicates whether the snapshot set is write-order consistent." | |
| }, | |
| "placement_rule" : { | |
| "$ref" : "#/definitions/VGPlacementRule" | |
| }, | |
| "type" : { | |
| "$ref" : "#/definitions/VolumeTypeEnum" | |
| }, | |
| "is_replication_destination" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "Indicates whether this volume group is a replication destination. A replication destination will be created by the system when a replication session is created. When there is an active replication session, all the user operations are restricted including modification, deletion, host operation, snapshot, clone, etc. After the replication session is deleted, the replication destination will remain as it is until the end user changes it to be a non-replication destination. After the change, it becomes a primary volume group. If the end user keeps it as a replication destination, when the replication session is recreated, the replication destination could potentially be reused in the new session to avoid a time-consuming full sync. This property is only valid for primary and clone volume groups." | |
| }, | |
| "protection_data" : { | |
| "$ref" : "#/definitions/protection_data_instance" | |
| }, | |
| "is_importing" : { | |
| "description" : "Indicates whether the volume group is being imported.", | |
| "type" : "boolean" | |
| }, | |
| "location_history" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/location_history_instance" | |
| }, | |
| "description" : "A list of locations. The list of locations includes the move to the current appliance. \nFiltering on the fields of this embedded resource is not supported.", | |
| "x-no_filter" : true | |
| }, | |
| "type_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to type" | |
| }, | |
| "protection_policy" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/policy_instance", | |
| "description" : "This is the embeddable reference form of protection_policy_id attribute.", | |
| "x-ref" : "policy" | |
| }, | |
| "migration_session" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/migration_session_instance", | |
| "description" : "This is the embeddable reference form of migration_session_id attribute.", | |
| "x-ref" : "migration_session" | |
| }, | |
| "volumes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/volume_instance", | |
| "x-ref" : "volume" | |
| }, | |
| "description" : "List of the volumes that are associated with this volume_group." | |
| } | |
| } | |
| }, | |
| "volume_group_create" : { | |
| "description" : "Create volume group request.", | |
| "required" : [ "name" ], | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Unique name for the volume group. The name should contain no special HTTP characters and no unprintable characters. Although the case of the name provided is reserved, uniqueness check is case-insensitive, so the same name in two different cases is not considered unique.", | |
| "maxLength" : 128 | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "Description for the volume group. The description should not be more than 256\ncharacters long and should not have any unprintable characters.\n\nIf description is not specified, the description for the volume group will not be set.", | |
| "maxLength" : 256 | |
| }, | |
| "volume_ids" : { | |
| "type" : "array", | |
| "description" : "A list of identifiers of existing volumes that should be added to the volume group. \n\nAll the volumes must be on the same Cyclone appliance and should not be part of another volume group.\n\nIf a list of volumes is not specified or if the specified list is empty, an\nempty volume group of type Volume will be created.", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| }, | |
| "is_write_order_consistent" : { | |
| "type" : "boolean", | |
| "default" : true, | |
| "description" : "A boolean flag to indicate whether snapshot sets of the volume group will be write-order consistent.\n\nThis parameter defaults to true, if not specified." | |
| }, | |
| "protection_policy_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of an optional protection policy to assign to the volume group." | |
| } | |
| } | |
| }, | |
| "volume_group_modify" : { | |
| "description" : "Modify volume group request.", | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "New name for the volume group. The name should contain no special HTTP characters and no unprintable characters. Although the case of the name provided is reserved, uniqueness check is case-insensitive, so the same name in two different cases is not considered unique.", | |
| "maxLength" : 128 | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "New description for the volume group. The description should not have any unprintable characters.\nIf an empty string is specified, the description will be cleared.", | |
| "maxLength" : 256 | |
| }, | |
| "is_write_order_consistent" : { | |
| "type" : "boolean", | |
| "description" : "A boolean flag to indicate whether snapshot sets of the volume group will be write-order consistent.\n\nThis parameter is only valid when modifying a primary or a clone volume group." | |
| }, | |
| "protection_policy_id" : { | |
| "description" : "Unique identifier of the protection policy to assign to a primary or clone volume group. \nIf an empty string is specified, protection policy will be removed from the volume group.", | |
| "type" : "string" | |
| }, | |
| "is_replication_destination" : { | |
| "type" : "boolean", | |
| "description" : "New value for is_replication_destination property. is_replication_destination property of all the volumes in the volume group will be modified to the specified value. \n\nModification of is_replication will not be transactional in nature. If the command only succeeds in modifying the is_replication_destination property of a subset of volumes, is_replication_destination property for the volume group will be set to true.\n\nModification of this property is idempotent.\n\nThis parameter is only valid when modifying a primary or a clone volume group, only when the volume group is no longer the destination of a replication session, and may only be set to false." | |
| }, | |
| "force" : { | |
| "description" : "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 needs to be cleaned up.\nWith the force option, the user will be allowed to remove the protection policy from the replication destination volume group provided that the replication session has never been synchronized.\nThis parameter defaults to false, if not specified.", | |
| "type" : "boolean", | |
| "default" : false | |
| } | |
| }, | |
| "default" : false | |
| }, | |
| "volume_group_delete" : { | |
| "description" : "Delete volume group request.", | |
| "properties" : { | |
| "delete_members" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "By default, the members of a volume group being deleted are only removed. Set this optional parameter to true to override this behavior and also delete the members after they are removed from the volume group.\nThis parameter defaults to false, if not specified." | |
| } | |
| } | |
| }, | |
| "volume_group_add_members" : { | |
| "description" : "Request to add members to a volume group.", | |
| "required" : [ "volume_ids" ], | |
| "properties" : { | |
| "volume_ids" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| }, | |
| "description" : "A list of primary or clone volumes to be added to the volume group. Snapshots cannot be added to a volume group. All the volumes should be on the same appliance as the current members of the volume group.\nThis list cannot be empty." | |
| } | |
| } | |
| }, | |
| "volume_group_remove_members" : { | |
| "description" : "Request to remove members from a volume group.", | |
| "required" : [ "volume_ids" ], | |
| "properties" : { | |
| "volume_ids" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "x-ref" : "volume" | |
| }, | |
| "description" : "A list of volumes that need to be removed from the volume group.\nThis list cannot be empty." | |
| } | |
| } | |
| }, | |
| "volume_group_snapshot" : { | |
| "type" : "object", | |
| "description" : "Snapshot volume group request.", | |
| "required" : [ "name" ], | |
| "properties" : { | |
| "name" : { | |
| "description" : "Unique name of the snapshot set to be created.", | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "description" : "Optional description for the snapshot set.\nIf description is not specified, the description for the snapshot set will not be set.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "volume_group_clone" : { | |
| "description" : "Clone volume group request.", | |
| "required" : [ "name" ], | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Unique name for the clone volume group." | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "Description for the clone volume group.\nIf description is not specified, the description for the snapshot set will not be set." | |
| }, | |
| "protection_policy_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the protection policy you want to assign to the clone volume group." | |
| }, | |
| "is_replication_destination" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "A boolean flag to indicate whether the clone volume group is a destination of a replication session.\nThis parameter defaults to false, if not specified." | |
| } | |
| } | |
| }, | |
| "volume_group_restore" : { | |
| "description" : "Restore volume group request.", | |
| "required" : [ "from_snap_id" ], | |
| "properties" : { | |
| "from_snap_id" : { | |
| "description" : "Unique identifier of the snapshot set to restore from. This is referred to as the source volume group.", | |
| "type" : "string" | |
| }, | |
| "create_backup_snap" : { | |
| "description" : "This parameter specifies whether a backup snapshot set of the target volume group needs to be created before attempting restore. This parameter defaults to true, if not specified.", | |
| "type" : "boolean", | |
| "default" : true | |
| }, | |
| "backup_snap_profile" : { | |
| "$ref" : "#/definitions/volume_group_snapshot" | |
| } | |
| } | |
| }, | |
| "volume_group_refresh" : { | |
| "description" : "Refresh volume group request.", | |
| "required" : [ "from_object_id" ], | |
| "properties" : { | |
| "from_object_id" : { | |
| "description" : "Unique identifier of the volume group to refresh from. This is referred to as the source volume group.", | |
| "type" : "string" | |
| }, | |
| "create_backup_snap" : { | |
| "description" : "This parameter specifies whether a backup snapshot set of the target volume group needs to be created before refreshing it.\nThis parameter defaults to true, if not specified.", | |
| "type" : "boolean", | |
| "default" : true | |
| }, | |
| "backup_snap_profile" : { | |
| "$ref" : "#/definitions/volume_group_snapshot" | |
| } | |
| } | |
| }, | |
| "volume_group_restore_response" : { | |
| "description" : "volume group restore response.", | |
| "properties" : { | |
| "backup_snapshot_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the backup snapshot set. This parameter will not be available if the __create_backup_snap__ was set to false." | |
| } | |
| } | |
| }, | |
| "volume_group_refresh_response" : { | |
| "description" : "volume group refresh response.", | |
| "properties" : { | |
| "backup_snapshot_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the backup snapshot set. This parameter will not be available if the __create_backup_snap__ flag was set to false." | |
| } | |
| } | |
| }, | |
| "volume_group_clone_response" : { | |
| "type" : "object", | |
| "description" : "Response for volume group clone action", | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the new instance created." | |
| } | |
| } | |
| }, | |
| "volume_group_snapshot_response" : { | |
| "description" : "Unique identifier of the new snapshot volume.", | |
| "properties" : { | |
| "id" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "chap_config_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "mode" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique id of the CHAP config settings instance (always \"0\")." | |
| }, | |
| "mode" : { | |
| "$ref" : "#/definitions/CHAPModeEnum" | |
| }, | |
| "mode_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to mode" | |
| } | |
| } | |
| }, | |
| "chap_config_modify" : { | |
| "type" : "object", | |
| "required" : [ "mode" ], | |
| "properties" : { | |
| "mode" : { | |
| "$ref" : "#/definitions/CHAPModeEnum" | |
| } | |
| } | |
| }, | |
| "CHAPModeEnum" : { | |
| "description" : "Available CHAP modes that describe or set the iSCSI CHAP mode for the entire cluster.\n * Disabled - CHAP is not used in the cluster\n * Single - CHAP is being used to authenticate the initiator \n * Mutual - CHAP is used to authenticate both the initiator and target\n ", | |
| "type" : "string", | |
| "enum" : [ "Disabled", "Single", "Mutual" ], | |
| "x-display_enum_text" : { | |
| "Disabled" : "Disabled", | |
| "Single" : "Single", | |
| "Mutual" : "Mutual" | |
| } | |
| }, | |
| "nas_server_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "name", "operational_status", "current_node_id", "preferred_node_id", "file_interfaces.ip_address" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server." | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the NAS server. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "Description of the NAS server." | |
| }, | |
| "operational_status" : { | |
| "$ref" : "#/definitions/NASServerOperationalStatusEnum" | |
| }, | |
| "current_node_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the node on which the NAS server is running." | |
| }, | |
| "preferred_node_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the preferred node for the NAS server The initial value (on NAS server creation) is taken from the current node." | |
| }, | |
| "default_unix_user" : { | |
| "type" : "string", | |
| "description" : "Default Unix user name used for granting access in case of Windows to Unix user mapping failure. When empty, access in such case is denied." | |
| }, | |
| "default_windows_user" : { | |
| "type" : "string", | |
| "description" : "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." | |
| }, | |
| "current_unix_directory_service" : { | |
| "$ref" : "#/definitions/NASServerCurrentUnixDirectoryServiceEnum" | |
| }, | |
| "is_username_translation_enabled" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "Enable the possibility to match a windows account to a Unix account with different names." | |
| }, | |
| "is_auto_user_mapping_enabled" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "A Windows user must have a corresponding matching Unix user (uid) in order to connect.\nThis attribute enables you to automatically generate this Unix user (uid), if that Windows user does not have any in the configured Unix directory service (UDS).\nIn a pure SMB or non multi-protocol environment, this should be set to true.\n" | |
| }, | |
| "production_IPv4_interface_id" : { | |
| "description" : "Unique identifier of the preferred IPv4 production interface.", | |
| "type" : "string" | |
| }, | |
| "production_IPv6_interface_id" : { | |
| "description" : "Unique identifier of the preferred IPv6 production interface.", | |
| "type" : "string" | |
| }, | |
| "backup_IPv4_interface_id" : { | |
| "description" : "Unique identifier of the preferred IPv4 backup interface.", | |
| "type" : "string" | |
| }, | |
| "backup_IPv6_interface_id" : { | |
| "description" : "Unique identifier of the preferred IPv6 backup interface.", | |
| "type" : "string" | |
| }, | |
| "current_preferred_IPv4_interface_id" : { | |
| "description" : "Unique identifier of the current active preferred IPv4 interface.", | |
| "type" : "string" | |
| }, | |
| "current_preferred_IPv6_interface_id" : { | |
| "description" : "Unique identifier of the current active preferred IPv6 interface.", | |
| "type" : "string" | |
| }, | |
| "operational_status_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to operational_status" | |
| }, | |
| "current_unix_directory_service_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to current_unix_directory_service" | |
| }, | |
| "file_interfaces" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_interface_instance", | |
| "x-ref" : "file_interface_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type file_interface association." | |
| }, | |
| "file_ndmps" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_ndmp_instance", | |
| "x-ref" : "file_ndmp_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type file_ndmp association." | |
| }, | |
| "file_virus_checkers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_virus_checker_instance", | |
| "x-ref" : "file_virus_checker_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type file_virus_checker association." | |
| }, | |
| "nfs_servers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/nfs_server_instance", | |
| "x-ref" : "nfs_server_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type nfs_server association." | |
| }, | |
| "smb_servers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/smb_server_instance", | |
| "x-ref" : "smb_server_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type smb_server association." | |
| }, | |
| "file_dnses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_dns_instance", | |
| "x-ref" : "file_dns_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type file_dns association." | |
| }, | |
| "file_ftps" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_ftp_instance", | |
| "x-ref" : "file_ftp_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type file_ftp association." | |
| }, | |
| "file_kerberoses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_kerberos_instance", | |
| "x-ref" : "file_kerberos_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type file_kerberos association." | |
| }, | |
| "file_ldaps" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_ldap_instance", | |
| "x-ref" : "file_ldap_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type file_ldap association." | |
| }, | |
| "file_nises" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_nis_instance", | |
| "x-ref" : "file_nis_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type file_nis association." | |
| }, | |
| "file_systems" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_system_instance", | |
| "x-ref" : "file_system_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type file_system association." | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from file_interface, file_ndmp, file_virus_checker, nfs_server, smb_server, file_dns, file_ftp, file_kerberos, file_ldap, file_nis, file_system" | |
| }, | |
| "nas_server_create" : { | |
| "type" : "object", | |
| "required" : [ "name" ], | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the NAS server.", | |
| "minLength" : 1, | |
| "maxLength" : 255 | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "Description of the NAS server.", | |
| "minLength" : 0, | |
| "maxLength" : 255 | |
| }, | |
| "current_unix_directory_service" : { | |
| "$ref" : "#/definitions/NASServerCurrentUnixDirectoryServiceEnum" | |
| }, | |
| "default_unix_user" : { | |
| "type" : "string", | |
| "description" : "Default Unix user name used for granting access in case of Windows to Unix user mapping failure. When empty, access in such case is denied.", | |
| "minLength" : 0, | |
| "maxLength" : 63 | |
| }, | |
| "default_windows_user" : { | |
| "type" : "string", | |
| "description" : "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.", | |
| "minLength" : 0, | |
| "maxLength" : 1023 | |
| }, | |
| "is_username_translation_enabled" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "Enable the possibility to match a Windows account with an Unix account with different names." | |
| }, | |
| "is_auto_user_mapping_enabled" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "A Windows user must have a corresponding matching Unix user (uid) in order to connect.\nThis attribute enables you to automatically generates this Unix user (uid), if that Windows user does not have any in the configured Unix directory service (UDS).\nIn a pure SMB or non multi-protocol environment, this should be set to true.\n" | |
| } | |
| } | |
| }, | |
| "nas_server_delete" : { | |
| "type" : "object", | |
| "description" : "Arguments for the Delete operation.", | |
| "properties" : { | |
| "is_skip_domain_unjoin" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "Indicates whether to keep the associated SMB servers joined to the Active Directory when the NAS server is 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 SMB servers from the Active Directory before deleting the NAS server." | |
| }, | |
| "domain_user_name" : { | |
| "type" : "string", | |
| "description" : "Administrator login used to unjoin the associated SMB servers from the Active Directory (AD) domain before deleting the NAS server. This parameter is required when the skipDomainUnjoin parameter is false or not set, and the NAS server has SMB servers joined to an AD domain." | |
| }, | |
| "domain_password" : { | |
| "type" : "string", | |
| "format" : "password", | |
| "description" : "Administrator password used to unjoin the associated SMB servers from the Active Directory (AD) domain before deleting the NAS server. This parameter is required when the skipDomainUnjoin parameter is false or not set, and the NAS server has SMB servers joined to an AD domain." | |
| } | |
| } | |
| }, | |
| "nas_server_modify" : { | |
| "type" : "object", | |
| "description" : "Arguments for the modify operation.", | |
| "properties" : { | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the NAS server.", | |
| "minLength" : 1, | |
| "maxLength" : 255 | |
| }, | |
| "description" : { | |
| "type" : "string", | |
| "description" : "Description of the NAS server.", | |
| "minLength" : 0, | |
| "maxLength" : 255 | |
| }, | |
| "current_node_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the node on which the NAS server is running." | |
| }, | |
| "preferred_node_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the preferred node for the NAS server The initial value (on NAS server create) is taken from the current node." | |
| }, | |
| "current_unix_directory_service" : { | |
| "$ref" : "#/definitions/NASServerCurrentUnixDirectoryServiceEnum" | |
| }, | |
| "default_unix_user" : { | |
| "type" : "string", | |
| "description" : "Default Unix user name used for granting access in case of Windows to Unix user mapping failure. When empty, access in such case is denied.", | |
| "minLength" : 0, | |
| "maxLength" : 63 | |
| }, | |
| "default_windows_user" : { | |
| "type" : "string", | |
| "description" : "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.", | |
| "minLength" : 0, | |
| "maxLength" : 1023 | |
| }, | |
| "is_username_translation_enabled" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "Enable the possibility to match a windows account to a Unix account with different names" | |
| }, | |
| "is_auto_user_mapping_enabled" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "A Windows user must have a corresponding matching Unix user (uid) in order to connect.\nThis attribute enables you to automatically generate this Unix user (uid), if that Windows user does not have any in the configured Unix directory service (UDS).\nIn a pure SMB or non multi-protocol environment, this should be set to true.\n" | |
| }, | |
| "production_IPv4_interface_id" : { | |
| "description" : "Unique identifier of the preferred IPv4 production interface.", | |
| "type" : "string" | |
| }, | |
| "production_IPv6_interface_id" : { | |
| "description" : "Unique identifier of the preferred IPv6 production interface.", | |
| "type" : "string" | |
| }, | |
| "backup_IPv4_interface_id" : { | |
| "description" : "Unique identifier of the preferred IPv4 backup interface.", | |
| "type" : "string" | |
| }, | |
| "backup_IPv6_interface_id" : { | |
| "description" : "Unique identifier of the preferred IPv6 backup interface.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "NASServerOperationalStatusEnum" : { | |
| "description" : "NAS server operational status:\n* Stopped - NAS server is stopped.\n* Starting - NAS server is starting.\n* Started - NAS server is started.\n* Stopping - NAS server is stopping.\n* Failover - NAS server has failed over.\n* Degraded - NAS server is degraded (running without backup).\n* Unknown - NAS server state is unknown.\n", | |
| "type" : "string", | |
| "enum" : [ "Stopped", "Starting", "Started", "Stopping", "Failover", "Degraded", "Unknown" ], | |
| "x-display_enum_text" : { | |
| "Stopped" : "Stopped", | |
| "Starting" : "Starting", | |
| "Started" : "Started", | |
| "Stopping" : "Stopping", | |
| "Failover" : "Failover", | |
| "Degraded" : "Degraded", | |
| "Unknown" : "Unknown" | |
| } | |
| }, | |
| "NASServerCurrentUnixDirectoryServiceEnum" : { | |
| "type" : "string", | |
| "description" : "Define the Unix directory service used for looking up identity information for Unix such as UIDs, GIDs, net groups, and so on.", | |
| "enum" : [ "None", "NIS", "LDAP", "Local_Files", "Local_Then_NIS", "Local_Then_LDAP" ], | |
| "x-display_enum_text" : { | |
| "None" : "None", | |
| "NIS" : "NIS", | |
| "LDAP" : "LDAP", | |
| "Local_Files" : "Local Files", | |
| "Local_Then_NIS" : "Local then NIS", | |
| "Local_Then_LDAP" : "Local then LDAP" | |
| } | |
| }, | |
| "nas_server_ping" : { | |
| "description" : "Request body for ping arguments.", | |
| "type" : "object", | |
| "properties" : { | |
| "destination_address" : { | |
| "type" : "string", | |
| "description" : "Destination to ping, can be either an IP address (IPv4 or IPv6) or a hostname being resolved by the NAS server name resolvers.", | |
| "format" : "ip-address" | |
| }, | |
| "is_ipv6" : { | |
| "type" : "boolean", | |
| "default" : false, | |
| "description" : "When true, and the destination is a hostname, it will be resolved to IPv6. Otherwise the hostname is resolved preferably to an IPv4 address." | |
| } | |
| } | |
| }, | |
| "nas_server_passwd_file" : { | |
| "type" : "string", | |
| "properties" : { | |
| "data" : { | |
| "description" : "passwd file." | |
| } | |
| } | |
| }, | |
| "nas_server_hosts_file" : { | |
| "type" : "string", | |
| "properties" : { | |
| "data" : { | |
| "description" : "hosts file." | |
| } | |
| } | |
| }, | |
| "nas_server_group_file" : { | |
| "type" : "string", | |
| "properties" : { | |
| "data" : { | |
| "description" : "group file." | |
| } | |
| } | |
| }, | |
| "nas_server_netgroup_file" : { | |
| "type" : "string", | |
| "properties" : { | |
| "data" : { | |
| "description" : "netgroup file." | |
| } | |
| } | |
| }, | |
| "nas_server_nsswitch_file" : { | |
| "type" : "string", | |
| "properties" : { | |
| "data" : { | |
| "description" : "nsswitch file." | |
| } | |
| } | |
| }, | |
| "nas_server_homedir_file" : { | |
| "type" : "string", | |
| "properties" : { | |
| "data" : { | |
| "description" : "homedir file." | |
| } | |
| } | |
| }, | |
| "nas_server_ntxmap_file" : { | |
| "type" : "string", | |
| "properties" : { | |
| "data" : { | |
| "description" : "ntxmap file." | |
| } | |
| } | |
| }, | |
| "nas_server_user_mapping_report_file" : { | |
| "type" : "string", | |
| "properties" : { | |
| "data" : { | |
| "description" : "user mapping report file." | |
| } | |
| } | |
| }, | |
| "file_interface_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "nas_server_id", "ip_address", "prefix_length", "gateway", "is_disabled" ], | |
| "properties" : { | |
| "id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the file interface." | |
| }, | |
| "nas_server_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server." | |
| }, | |
| "ip_address" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "description" : "IP address of the network interface. IPv4 and IPv6 are supported." | |
| }, | |
| "prefix_length" : { | |
| "type" : "integer", | |
| "format" : "int32", | |
| "description" : "Prefix length for the interface. IPv4 and IPv6 are supported.", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "gateway" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "description" : "Gateway address for the network interface. IPv4 and IPv6 are supported." | |
| }, | |
| "vlan_id" : { | |
| "type" : "integer", | |
| "format" : "int32", | |
| "description" : "Virtual Local Area Network (VLAN) identifier for the interface. The interface uses the identifier to accept packets that have matching VLAN tags.", | |
| "minimum" : 0, | |
| "maximum" : 4094, | |
| "default" : 0 | |
| }, | |
| "name" : { | |
| "type" : "string", | |
| "description" : "Name of the network interface. \nThis property supports case-insensitive filtering", | |
| "x-case-insensitive" : true | |
| }, | |
| "role" : { | |
| "$ref" : "#/definitions/FileInterfaceRoleEnum" | |
| }, | |
| "is_disabled" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the network interface is disabled.", | |
| "default" : false | |
| }, | |
| "role_l10n" : { | |
| "type" : "string", | |
| "description" : "Localized message string corresponding to role" | |
| }, | |
| "nas_server" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/nas_server_instance", | |
| "description" : "This is the embeddable reference form of nas_server_id attribute.", | |
| "x-ref" : "nas_server" | |
| }, | |
| "file_interface_routes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/file_interface_route_instance", | |
| "x-ref" : "file_interface_route_instance" | |
| }, | |
| "description" : "This is the inverse of the resource type file_interface_route association." | |
| } | |
| }, | |
| "description" : "This resource type has queriable associations from nas_server, file_interface_route" | |
| }, | |
| "file_interface_create" : { | |
| "description" : "Attributes for the create operation.", | |
| "type" : "object", | |
| "required" : [ "nas_server_id", "ip_address", "prefix_length" ], | |
| "properties" : { | |
| "nas_server_id" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the NAS server to which the network interface belongs, as defined by the nas_server resource type." | |
| }, | |
| "ip_address" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "minLength" : 1, | |
| "maxLength" : 45, | |
| "description" : "IP address of the network interface. IPv4 and IPv6 are supported." | |
| }, | |
| "prefix_length" : { | |
| "format" : "int32", | |
| "type" : "integer", | |
| "minimum" : 1, | |
| "maximum" : 128, | |
| "description" : "Prefix length for the interface. IPv4 and IPv6 are supported." | |
| }, | |
| "gateway" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "minLength" : 1, | |
| "maxLength" : 45, | |
| "description" : "Gateway address for the network interface. IPv4 and IPv6 are supported." | |
| }, | |
| "vlan_id" : { | |
| "type" : "integer", | |
| "format" : "int32", | |
| "description" : "Virtual Local Area Network (VLAN) identifier for the interface. The interface uses the identifier to accept packets that have matching VLAN tags.", | |
| "minimum" : 0, | |
| "maximum" : 4094, | |
| "default" : 0 | |
| }, | |
| "role" : { | |
| "$ref" : "#/definitions/FileInterfaceRoleEnum" | |
| }, | |
| "is_disabled" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the network interface is disabled.", | |
| "default" : false | |
| } | |
| } | |
| }, | |
| "file_interface_modify" : { | |
| "description" : "Attributes for the modify operation.", | |
| "type" : "object", | |
| "properties" : { | |
| "ip_address" : { | |
| "type" : "string", | |
| "minLength" : 1, | |
| "maxLength" : 45, | |
| "format" : "ip-address", | |
| "description" : "IP address of the network interface. IPv4 and IPv6 are supported." | |
| }, | |
| "prefix_length" : { | |
| "format" : "int32", | |
| "type" : "integer", | |
| "minimum" : 1, | |
| "maximum" : 128, | |
| "description" : "Prefix length for the interface. IPv4 and IPv6 are supported." | |
| }, | |
| "gateway" : { | |
| "type" : "string", | |
| "format" : "ip-address", | |
| "minLength" : 0, | |
| "maxLength" : 45, | |
| "description" : "Gateway address for the network interface. IPv4 and IPv6 are supported." | |
| }, | |
| "vlan_id" : { | |
| "type" : "integer", | |
| "format" : "int32", | |
| "description" : "Virtual Local Area Network (VLAN) identifier for the interface. The interface uses the identifier to accept packets that have matching VLAN tags.", | |
| "minimum" : 0, | |
| "maximum" : 4094, | |
| "default" : 0 | |
| }, | |
| "is_disabled" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether the network interface is disabled.", | |
| "default" : false | |
| } | |
| } | |
| }, | |
| "FileInterfaceRoleEnum" : { | |
| "description" : "- 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. \n- 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.\n", | |
| "type" : "string", | |
| "enum" : [ "Production", "Backup" ], | |
| "x-display_enum_text" : { | |
| "Production" : "Production", | |
| "Backup" : "Backup" | |
| } | |
| }, | |
| "file_ndmp_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "nas_server_id", "user_name", "nas_server.name" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the NDMP service object.", | |
| "type" : "string", | |
| "readOnly" : true | |
| }, | |
| "nas_server_id" : { | |
| "description" : "Unique identifier of the NAS server to be configured with these NDMP settings.", | |
| "type" : "string" | |
| }, | |
| "user_name" : { | |
| "description" : "User name for accessing the NDMP service.", | |
| "type" : "string" | |
| }, | |
| "nas_server" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/nas_server_instance", | |
| "description" : "This is the embeddable reference form of nas_server_id attribute.", | |
| "x-ref" : "nas_server" | |
| } | |
| }, | |
| "description" : "This resource type has queriable association from nas_server" | |
| }, | |
| "file_ndmp_create" : { | |
| "type" : "object", | |
| "required" : [ "nas_server_id", "user_name", "password" ], | |
| "properties" : { | |
| "nas_server_id" : { | |
| "description" : "Unique identifier of the NAS server to be configured with these NDMP settings.", | |
| "type" : "string" | |
| }, | |
| "user_name" : { | |
| "description" : "User name for accessing the NDMP service.", | |
| "type" : "string" | |
| }, | |
| "password" : { | |
| "description" : "Password for the NDMP service user.", | |
| "type" : "string", | |
| "format" : "password" | |
| } | |
| } | |
| }, | |
| "file_ndmp_modify" : { | |
| "type" : "object", | |
| "properties" : { | |
| "user_name" : { | |
| "description" : "User name for accessing the NDMP service.", | |
| "type" : "string" | |
| }, | |
| "password" : { | |
| "description" : "Password for the NDMP service user.", | |
| "type" : "string", | |
| "format" : "password" | |
| } | |
| } | |
| }, | |
| "file_virus_checker_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "nas_server_id", "is_enabled", "is_config_file_uploaded", "nas_server.name" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the virus checker instance.", | |
| "type" : "string" | |
| }, | |
| "nas_server_id" : { | |
| "description" : "NAS server that is configured with these anti-virus settings.", | |
| "type" : "string" | |
| }, | |
| "is_enabled" : { | |
| "description" : "Indicates whether the anti-virus service is enabled on this NAS server. Value are:\n- 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, the access to the file system is denied. If third-party anti-virus servers are not available, according the policy, the access to the file systems is denied to prevent potential viruses propagation.\n- false - Anti-virus service is disabled. File systems of the NAS servers are available for access without virus checking\n", | |
| "type" : "boolean" | |
| }, | |
| "is_config_file_uploaded" : { | |
| "description" : "Indicates whether a virus checker configuration file has been uploaded.", | |
| "type" : "boolean", | |
| "default" : false | |
| }, | |
| "nas_server" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/nas_server_instance", | |
| "description" : "This is the embeddable reference form of nas_server_id attribute.", | |
| "x-ref" : "nas_server" | |
| } | |
| }, | |
| "description" : "This resource type has queriable association from nas_server" | |
| }, | |
| "file_virus_checker_create" : { | |
| "type" : "object", | |
| "required" : [ "nas_server_id" ], | |
| "properties" : { | |
| "nas_server_id" : { | |
| "description" : "Unique identifier of an associated NAS Server instance that uses this virus checker configuration. Only one virus checker configuration per NAS Server is supported.", | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "file_virus_checker_modify" : { | |
| "type" : "object", | |
| "required" : [ "is_enabled" ], | |
| "properties" : { | |
| "is_enabled" : { | |
| "description" : "Indicates whether the anti-virus service is enabled on this NAS server. Value are:\n- 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, the access to the file system is denied. If third-party anti-virus servers are not available, according the policy, the access to the file systems is denied to prevent potential viruses propagation.\n- false - Anti-virus service is disabled. File systems of the NAS servers are available for access without virus checking.\n", | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "file_virus_checker_config_file" : { | |
| "type" : "string", | |
| "properties" : { | |
| "data" : { | |
| "description" : "Virus checker configuration file." | |
| } | |
| } | |
| }, | |
| "nfs_server_instance" : { | |
| "type" : "object", | |
| "x-select_cli" : [ "id", "nas_server_id", "is_nfsv3_enabled", "is_nfsv4_enabled", "nas_server.name" ], | |
| "properties" : { | |
| "id" : { | |
| "description" : "Unique identifier of the NFS server.", | |
| "type" : "string" | |
| }, | |
| "host_name" : { | |
| "description" : "The name that will be used by NFS clients to connect to this NFS server. This name is required when using secure NFS, except when is_use_smb_config_enabled is true. In this case host_name is forced to the SMB server computer name, and must not be specified.\n", | |
| "type" : "string" | |
| }, | |
| "nas_server_id" : { | |
| "description" : "The unique identifier of the NAS server that serves this share.", | |
| "type" : "string" | |
| }, | |
| "is_nfsv3_enabled" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether NFSv3 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv3. When disabled, NFS shares cannot be accessed with NFSv3 protocol.\n- true - NFSv3 is enabled on the specified NAS server.\n- false - NFSv3 is disabled on the specified NAS server.\n" | |
| }, | |
| "is_nfsv4_enabled" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether NFSv4 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv4. When disabled, NFS shares cannot be accessed with NFSv4 protocol.\n- true - NFSv4 is enabled on the specified NAS server.\n- false - NFSv4 is disabled on the specified NAS server.\n" | |
| }, | |
| "is_secure_enabled" : { | |
| "description" : "Indicates whether secure NFS is enabled on the NFS server.\n- true - Secure NFS is Enabled.\n- false - Secure NFS is disabled.\n", | |
| "type" : "boolean" | |
| }, | |
| "is_use_smb_config_enabled" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether SMB authentication is used to authenticate to the KDC. Values are:\n- true: Indicates that the the configured SMB Server settings are used for Kerberos authentication.\n- false: Indicates that Kerberos uses its own settings.\n", | |
| "default" : false | |
| }, | |
| "service_principal_name" : { | |
| "description" : "The Service Principal Name (SPN) for the NFS server. This name is updated automatically when the NFS server configuration changes.", | |
| "type" : "string" | |
| }, | |
| "is_joined" : { | |
| "description" : "Indicates whether the NFS server is joined to Active Directory. Required for Secure NFS. Always false when secure NFS is disabled and kdc_type is not MS Windows.", | |
| "type" : "boolean" | |
| }, | |
| "is_extended_credentials_enabled" : { | |
| "description" : "Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential. Valid values are,\n- true - NFS server supports more than 16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups.\n- false - NFS server supports more than 16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups. \nNote - The NFS server builds its own Unix credential when it supports more than 16 groups. This process can slow performance.\n", | |
| "type" : "boolean", | |
| "default" : false | |
| }, | |
| "credentials_cache_TTL" : { | |
| "description" : "Sets the Time-To-Live (in minutes) expiration timestamp for a Windows entry in the credentials cache. When failed mapping entries expire, the system retries mapping the UID to the SID.", | |
| "type" : "integer", | |
| "default" : 5, | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| }, | |
| "nas_server" : { | |
| "type" : "object", | |
| "$ref" : "#/definitions/nas_server_instance", | |
| "description" : "This is the embeddable reference form of nas_server_id attribute.", | |
| "x-ref" : "nas_server" | |
| } | |
| }, | |
| "description" : "This resource type has queriable association from nas_server" | |
| }, | |
| "nfs_server_create" : { | |
| "type" : "object", | |
| "description" : "Argument for the NFS server create operation.", | |
| "required" : [ "nas_server_id" ], | |
| "properties" : { | |
| "nas_server_id" : { | |
| "description" : "Unique identifier of the NAS server.", | |
| "type" : "string" | |
| }, | |
| "host_name" : { | |
| "description" : "The name that will be used by NFS clients to connect to this NFS server. This name is required when using secure NFS, except when is_use_smb_config_enabled is true. In this case host_name is forced to the SMB server computer name, and must not be specified.\n", | |
| "type" : "string", | |
| "minLength" : 1, | |
| "maxLength" : 255 | |
| }, | |
| "is_nfsv3_enabled" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether NFSv3 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv3. When disabled, NFS shares can not be accessed with NFSv3 protocol.\n- true - NFSv3 is enabled on the specified NAS server.\n- false - NFSv3 is disabled on the specified NAS server.\n", | |
| "default" : true | |
| }, | |
| "is_nfsv4_enabled" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether NFSv4 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv4. When disabled, NFS shares can not be accessed with NFSv4 protocol.\n- true - NFSv4 is enabled on the specified NAS server.\n- false - NFSv4 is disabled on the specified NAS server.\n", | |
| "default" : false | |
| }, | |
| "is_secure_enabled" : { | |
| "description" : "Indicates whether secure NFS is enabled on the NFS server.\n- true - Secure NFS is Enabled.\n- false - Secure NFS is disabled.\n", | |
| "type" : "boolean", | |
| "default" : false | |
| }, | |
| "is_use_smb_config_enabled" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether SMB authentication is used to authenticate to the KDC. Values are:\n- true: Indicates that the configured SMB Server settings are used for Kerberos authentication.\n- false: Indicates that Kerberos uses its own settings.\n", | |
| "default" : false | |
| }, | |
| "is_extended_credentials_enabled" : { | |
| "description" : "Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential. Valid values are,\n- true - NFS server supports more than 16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups.\n- false - NFS server supports more than 16 Unix groups in a Unix credential. The NFS server will send additional request to Unix Directory service to identify Unix groups. \nNote - The NFS server builds its own Unix credential when it supports more than 16 groups. This process can slow performance.\n", | |
| "default" : false, | |
| "type" : "boolean" | |
| }, | |
| "credentials_cache_TTL" : { | |
| "description" : "Sets the Time-To-Live (in minutes) expiration time in minutes for a Windows entry in the credentials cache. When failed mapping entries expire, the system retries mapping the UID to the SID.", | |
| "default" : 5, | |
| "type" : "integer", | |
| "format" : "int32", | |
| "minimum" : 0, | |
| "maximum" : 2147483647 | |
| } | |
| } | |
| }, | |
| "nfs_server_delete" : { | |
| "type" : "object", | |
| "description" : "Arguments for the NFS server Delete operation.", | |
| "properties" : { | |
| "is_skip_unjoin" : { | |
| "description" : "Allow to bypass NFS server unjoin. If false delete will fail if secure is enabled and current kdc_type is MS Windows. If secure is enabled either unjoin NFS server before doing delete or set value to true.", | |
| "default" : false, | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "nfs_server_modify" : { | |
| "type" : "object", | |
| "description" : "Arguments for the NFS server modify operation.", | |
| "properties" : { | |
| "host_name" : { | |
| "description" : "The name that will be used by NFS clients to connect to this NFS server. This name is required when using secure NFS, except when is_use_smb_config_enabled is true. In this case host_name is forced to the SMB server computer name, and must not be specified.\n", | |
| "type" : "string", | |
| "minLength" : 1, | |
| "maxLength" : 255 | |
| }, | |
| "is_nfsv3_enabled" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether NFSv3 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv3. When disabled, NFS shares cannot be accessed with NFSv3 protocol.\n- true - NFSv3 is enabled on the specified NAS server.\n- false - NFSv3 is disabled on the specified NAS server.\n" | |
| }, | |
| "is_nfsv4_enabled" : { | |
| "type" : "boolean", | |
| "description" : "Indicates whether NFSv4 is enabled on the NAS server. When enabled, NFS shares can be accessed with NFSv4. When disabled, NFS shares cannot be accessed with NFSv4 protocol.\n- true - NFSv4 is enabled on the specified NAS server.\n- false - NFSv4 is disabled on the specified NAS server.\n" | |
| }, | |
| "is_secure_enabled" : { | |
| "description" : "Indicates whether secure NFS is enabled on the NFS server.\n- true - Secure NFS is Enabled.\n- false - Secure NFS is disabled.\n", | |
| "type" : "boolean" | |
| }, | |
| "is_skip_unjoin" : { | |
| "description" : "Allow to bypass NFS server unjoin. If false modification will fail if secure is enabled and current kdc_type is MS Windows. If secure is enabled either unjoin NFS server before deleting or set value to true.", | |
| "type" : "boolean" | |
| }, | |
| "is_use_smb_conf |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment