Skip to content

README.md

Latest commit

 

History

History
1076 lines (1049 loc) · 101 KB

README.md

File metadata and controls

1076 lines (1049 loc) · 101 KB
Raw

Go API client for gopureclient

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project.

  • API version: 2.29
  • Package version: FA_2_29

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get github.com/stretchr/testify/require
go get golang.org/x/crypto
go get golang.org/x/sys
go get github.com/golang-jwt/jwt/v5

Put the package under your project folder and add the following in import:

import gopureclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_29"

Configuration

To build configuration use configuration builder.

An example for OAuth authentication where user is pureuser, issuer is go-test, key id is 123e4567-e89b-12d3-a456-426614174000, client id is 123e4567-e89b-12d3-a456-426614174000, privateKeyBytes contains RSA private key protected by password pwd123:

configuration, err := openapiclient.NewConfigurationBuilder("[ARRAY_URL]").
	OAuth("pureuser", "go-test", "123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174000", "pwd123", privateKeyBytes).
	DisableSSLVerification().
	Build()

An example for API token authentication:

configuration, err := openapiclient.NewConfigurationBuilder("[ARRAY_URL]").
	APIToken(apiToken).
	DisableSSLVerification().
	Build()

An example for anonymous authentication:

configuration, err := openapiclient.NewConfigurationBuilder("[ARRAY_URL]").
	DisableSSLVerification().
	Build()

Builder methods:

Method Description
UserAgent Sets custom user agent
DisableSSLVerification Disables verification of certificate chain
DebugMode Enables debug mode
HTTPClient Sets custom HTTPClient
Timeout Sets request timeout of the default HTTP client
OAuthWithRawTokenID Sets OAuth authentication with raw ID token
OAuth Sets OAuth authentication with private key
APIToken Sets API token authentication

By default requests time out after 90 seconds, including reading the response body. Use Timeout to change this, or Timeout(0) to disable it. When you bring your own client via HTTPClient, set the timeout on that client instead; combining it with Timeout is rejected by Build, as is DisableSSLVerification.

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
APIClientsAPI ApiClientsDelete Delete /api/2.29/api-clients Delete an API client
APIClientsAPI ApiClientsGet Get /api/2.29/api-clients List API clients
APIClientsAPI ApiClientsPatch Patch /api/2.29/api-clients Manage an API client
APIClientsAPI ApiClientsPost Post /api/2.29/api-clients Create an API client
ActiveDirectoryAPI ActiveDirectoryDelete Delete /api/2.29/active-directory Delete Active Directory account
ActiveDirectoryAPI ActiveDirectoryGet Get /api/2.29/active-directory List Active Directory accounts
ActiveDirectoryAPI ActiveDirectoryPatch Patch /api/2.29/active-directory Modify Active Directory account
ActiveDirectoryAPI ActiveDirectoryPost Post /api/2.29/active-directory Create Active Directory account
AdministratorsAPI AdminsAPITokensDelete Delete /api/2.29/admins/api-tokens Delete API tokens
AdministratorsAPI AdminsAPITokensGet Get /api/2.29/admins/api-tokens List API tokens
AdministratorsAPI AdminsAPITokensPost Post /api/2.29/admins/api-tokens Create API tokens
AdministratorsAPI AdminsCacheDelete Delete /api/2.29/admins/cache Delete cache entries
AdministratorsAPI AdminsCacheGet Get /api/2.29/admins/cache List administrator cache entries
AdministratorsAPI AdminsCachePut Put /api/2.29/admins/cache Update or refresh entries in the administrator cache
AdministratorsAPI AdminsDelete Delete /api/2.29/admins Deletes an administrator
AdministratorsAPI AdminsGet Get /api/2.29/admins List administrators
AdministratorsAPI AdminsPatch Patch /api/2.29/admins Modify an administrator
AdministratorsAPI AdminsPost Post /api/2.29/admins Create an administrator
AdministratorsAPI AdminsSettingsGet Get /api/2.29/admins/settings List administrator settings
AdministratorsAPI AdminsSettingsPatch Patch /api/2.29/admins/settings Modify administrator settings
AlertWatchersAPI AlertWatchersDelete Delete /api/2.29/alert-watchers Delete alert watcher
AlertWatchersAPI AlertWatchersGet Get /api/2.29/alert-watchers List alert watchers
AlertWatchersAPI AlertWatchersPatch Patch /api/2.29/alert-watchers Modify alert watcher
AlertWatchersAPI AlertWatchersPost Post /api/2.29/alert-watchers Create alert watcher
AlertWatchersAPI AlertWatchersTestGet Get /api/2.29/alert-watchers/test List alert watcher test
AlertsAPI AlertsEventsGet Get /api/2.29/alerts/events List alert events
AlertsAPI AlertsGet Get /api/2.29/alerts List alerts
AlertsAPI AlertsPatch Patch /api/2.29/alerts Modify flagged state
AlertsAPI AlertsRulesCatalogGet Get /api/2.29/alerts/rules/catalog List available customizable alert codes
AlertsAPI AlertsRulesDelete Delete /api/2.29/alerts/rules Delete a custom alert rule
AlertsAPI AlertsRulesGet Get /api/2.29/alerts/rules List custom alert rules
AlertsAPI AlertsRulesPatch Patch /api/2.29/alerts/rules Modify a custom alert rule
AlertsAPI AlertsRulesPost Post /api/2.29/alerts/rules Create a custom alert rule
AppsAPI AppsGet Get /api/2.29/apps List apps
AppsAPI AppsNodesGet Get /api/2.29/apps/nodes List app nodes
AppsAPI AppsPatch Patch /api/2.29/apps Modify app
ArrayConnectionsAPI ArrayConnectionsConnectionKeyGet Get /api/2.29/array-connections/connection-key List connection key
ArrayConnectionsAPI ArrayConnectionsDelete Delete /api/2.29/array-connections Delete an array connection
ArrayConnectionsAPI ArrayConnectionsGet Get /api/2.29/array-connections List connected arrays
ArrayConnectionsAPI ArrayConnectionsPatch Patch /api/2.29/array-connections Modify an array connection
ArrayConnectionsAPI ArrayConnectionsPathGet Get /api/2.29/array-connections/path List connection path
ArrayConnectionsAPI ArrayConnectionsPost Post /api/2.29/array-connections Create an array connection
ArraysAPI ArraysCloudCapacityGet Get /api/2.29/arrays/cloud-capacity List CBS array capacity status
ArraysAPI ArraysCloudCapacityPatch Patch /api/2.29/arrays/cloud-capacity Modify CBS array capacity
ArraysAPI ArraysCloudCapacitySupportedStepsGet Get /api/2.29/arrays/cloud-capacity/supported-steps List CBS array capacity steps
ArraysAPI ArraysCloudProviderTagsBatchPut Put /api/2.29/arrays/cloud-provider-tags/batch Update user tags on the cloud.
ArraysAPI ArraysCloudProviderTagsDelete Delete /api/2.29/arrays/cloud-provider-tags Delete user tags from the cloud.
ArraysAPI ArraysCloudProviderTagsGet Get /api/2.29/arrays/cloud-provider-tags List user tags on the cloud.
ArraysAPI ArraysDelete Delete /api/2.29/arrays Delete an array
ArraysAPI ArraysEulaGet Get /api/2.29/arrays/eula List End User Agreement and signature
ArraysAPI ArraysEulaPatch Patch /api/2.29/arrays/eula Modify signature on the End User Agreement
ArraysAPI ArraysFactoryResetTokenDelete Delete /api/2.29/arrays/factory-reset-token Delete a factory reset token
ArraysAPI ArraysFactoryResetTokenGet Get /api/2.29/arrays/factory-reset-token List factory reset tokens
ArraysAPI ArraysFactoryResetTokenPost Post /api/2.29/arrays/factory-reset-token Create a factory reset token
ArraysAPI ArraysGet Get /api/2.29/arrays List arrays
ArraysAPI ArraysNtpTestGet Get /api/2.29/arrays/ntp-test List NTP test results
ArraysAPI ArraysPatch Patch /api/2.29/arrays Modify an array
ArraysAPI ArraysPerformanceByLinkGet Get /api/2.29/arrays/performance/by-link List array front-end IO performance data by link
ArraysAPI ArraysPerformanceGet Get /api/2.29/arrays/performance List array front-end performance data
ArraysAPI ArraysSpaceGet Get /api/2.29/arrays/space List array space information
AuditsAPI AuditsGet Get /api/2.29/audits List audits
AuthorizationAPI LoginPost Post /api/2.29/login POST login (placeholder)
AuthorizationAPI LogoutPost Post /api/2.29/logout POST logout (placeholder)
AuthorizationAPI ApiAPIVersionGet Get /api/api_version List available API versions
AuthorizationAPI Oauth210TokenPost Post /oauth2/1.0/token Get access token
CertificatesAPI CertificatesCertificateSigningRequestsPost Post /api/2.29/certificates/certificate-signing-requests Create certificate signing request
CertificatesAPI CertificatesDelete Delete /api/2.29/certificates Delete certificate
CertificatesAPI CertificatesGet Get /api/2.29/certificates List certificate attributes
CertificatesAPI CertificatesPatch Patch /api/2.29/certificates Modify certificates
CertificatesAPI CertificatesPost Post /api/2.29/certificates Create certificate
ConnectionsAPI ConnectionsDelete Delete /api/2.29/connections Delete a connection between a volume and its host or host group
ConnectionsAPI ConnectionsGet Get /api/2.29/connections List volume connections
ConnectionsAPI ConnectionsPost Post /api/2.29/connections Create a connection between a volume and host or host group
ContainerDefaultProtectionsAPI ContainerDefaultProtectionsGet Get /api/2.29/container-default-protections List container default protections
ContainerDefaultProtectionsAPI ContainerDefaultProtectionsPatch Patch /api/2.29/container-default-protections Modify a container's default protections
ControllersAPI ControllersGet Get /api/2.29/controllers List controller information and status
DNSAPI DnsDelete Delete /api/2.29/dns Delete DNS configuration
DNSAPI DnsGet Get /api/2.29/dns List DNS parameters
DNSAPI DnsPatch Patch /api/2.29/dns Modify DNS parameters
DNSAPI DnsPost Post /api/2.29/dns Create DNS configuration
DirectoriesAPI DirectoriesDelete Delete /api/2.29/directories Delete managed directories
DirectoriesAPI DirectoriesGet Get /api/2.29/directories List directories
DirectoriesAPI DirectoriesLocksNlmReclamationsPost Post /api/2.29/directories/locks/nlm-reclamations Initiate NLM reclamation.
DirectoriesAPI DirectoriesPatch Patch /api/2.29/directories Modify a managed directory
DirectoriesAPI DirectoriesPerformanceGet Get /api/2.29/directories/performance List directory performance data
DirectoriesAPI DirectoriesPoliciesAutodirDelete Delete /api/2.29/directories/policies/autodir Delete a membership between a directory and one or more auto managed directory policies
DirectoriesAPI DirectoriesPoliciesAutodirGet Get /api/2.29/directories/policies/autodir List auto managed directory policies attached to a directory
DirectoriesAPI DirectoriesPoliciesAutodirPost Post /api/2.29/directories/policies/autodir Create a membership between a directory with one or more auto managed directory policies
DirectoriesAPI DirectoriesPoliciesGet Get /api/2.29/directories/policies List policies
DirectoriesAPI DirectoriesPoliciesNfsDelete Delete /api/2.29/directories/policies/nfs Delete a membership between a directory and one or more NFS policies
DirectoriesAPI DirectoriesPoliciesNfsGet Get /api/2.29/directories/policies/nfs List NFS policies attached to a directory
DirectoriesAPI DirectoriesPoliciesNfsPost Post /api/2.29/directories/policies/nfs Create a membership between a directory and one or more NFS policies
DirectoriesAPI DirectoriesPoliciesQuotaDelete Delete /api/2.29/directories/policies/quota Delete a membership between a directory and one or more quota policies
DirectoriesAPI DirectoriesPoliciesQuotaGet Get /api/2.29/directories/policies/quota List quota policies attached to a directory
DirectoriesAPI DirectoriesPoliciesQuotaPost Post /api/2.29/directories/policies/quota Create a membership between a directory and one or more quota policies
DirectoriesAPI DirectoriesPoliciesSmbDelete Delete /api/2.29/directories/policies/smb Delete a membership between a directory and one or more SMB policies
DirectoriesAPI DirectoriesPoliciesSmbGet Get /api/2.29/directories/policies/smb List SMB policies attached to a directory
DirectoriesAPI DirectoriesPoliciesSmbPost Post /api/2.29/directories/policies/smb Create a membership between a directory and one or more SMB policies
DirectoriesAPI DirectoriesPoliciesSnapshotDelete Delete /api/2.29/directories/policies/snapshot Delete a membership between a directory and one or more snapshot policies
DirectoriesAPI DirectoriesPoliciesSnapshotGet Get /api/2.29/directories/policies/snapshot List snapshot policies attached to a directory
DirectoriesAPI DirectoriesPoliciesSnapshotPost Post /api/2.29/directories/policies/snapshot Create a membership between a directory with one or more snapshot policies
DirectoriesAPI DirectoriesPost Post /api/2.29/directories Create directory
DirectoriesAPI DirectoriesSpaceGet Get /api/2.29/directories/space List directory space information
DirectoryExportsAPI DirectoryExportsDelete Delete /api/2.29/directory-exports Delete directory exports
DirectoryExportsAPI DirectoryExportsGet Get /api/2.29/directory-exports List directory exports
DirectoryExportsAPI DirectoryExportsPost Post /api/2.29/directory-exports Create directory exports
DirectoryQuotasAPI DirectoryQuotasGet Get /api/2.29/directory-quotas List directories with attached quota policies
DirectoryServicesAPI DirectoryServicesGet Get /api/2.29/directory-services List directory services configuration
DirectoryServicesAPI DirectoryServicesLocalGroupsDelete Delete /api/2.29/directory-services/local/groups Delete local groups
DirectoryServicesAPI DirectoryServicesLocalGroupsGet Get /api/2.29/directory-services/local/groups List local groups
DirectoryServicesAPI DirectoryServicesLocalGroupsMembersDelete Delete /api/2.29/directory-services/local/groups/members Delete local group membership
DirectoryServicesAPI DirectoryServicesLocalGroupsMembersGet Get /api/2.29/directory-services/local/groups/members List local group memberships
DirectoryServicesAPI DirectoryServicesLocalGroupsMembersPost Post /api/2.29/directory-services/local/groups/members Create local group membership
DirectoryServicesAPI DirectoryServicesLocalGroupsPatch Patch /api/2.29/directory-services/local/groups Modify local groups
DirectoryServicesAPI DirectoryServicesLocalGroupsPost Post /api/2.29/directory-services/local/groups Create local group
DirectoryServicesAPI DirectoryServicesLocalUsersDelete Delete /api/2.29/directory-services/local/users Delete local users
DirectoryServicesAPI DirectoryServicesLocalUsersGet Get /api/2.29/directory-services/local/users List local users
DirectoryServicesAPI DirectoryServicesLocalUsersMembersDelete Delete /api/2.29/directory-services/local/users/members Delete local user membership
DirectoryServicesAPI DirectoryServicesLocalUsersMembersGet Get /api/2.29/directory-services/local/users/members List local user memberships
DirectoryServicesAPI DirectoryServicesLocalUsersMembersPost Post /api/2.29/directory-services/local/users/members Create local user membership
DirectoryServicesAPI DirectoryServicesLocalUsersPatch Patch /api/2.29/directory-services/local/users Modify local user
DirectoryServicesAPI DirectoryServicesLocalUsersPost Post /api/2.29/directory-services/local/users Create local user
DirectoryServicesAPI DirectoryServicesPatch Patch /api/2.29/directory-services Modify directory services configuration
DirectoryServicesAPI DirectoryServicesRolesGet Get /api/2.29/directory-services/roles List directory services roles
DirectoryServicesAPI DirectoryServicesRolesPatch Patch /api/2.29/directory-services/roles Modify directory services roles
DirectoryServicesAPI DirectoryServicesTestGet Get /api/2.29/directory-services/test List directory services test results
DirectorySnapshotsAPI DirectorySnapshotsDelete Delete /api/2.29/directory-snapshots Delete directory snapshot
DirectorySnapshotsAPI DirectorySnapshotsGet Get /api/2.29/directory-snapshots List directory snapshots
DirectorySnapshotsAPI DirectorySnapshotsPatch Patch /api/2.29/directory-snapshots Modify directory snapshot
DirectorySnapshotsAPI DirectorySnapshotsPost Post /api/2.29/directory-snapshots Create directory snapshot
DrivesAPI DrivesGet Get /api/2.29/drives List flash, NVRAM, and cache modules
DrivesAPI DrivesPatch Patch /api/2.29/drives Modify flash and NVRAM modules
FileSystemsAPI FileSystemsDelete Delete /api/2.29/file-systems Delete file system
FileSystemsAPI FileSystemsGet Get /api/2.29/file-systems List file systems
FileSystemsAPI FileSystemsPatch Patch /api/2.29/file-systems Modify a file system
FileSystemsAPI FileSystemsPost Post /api/2.29/file-systems Create file system
FilesAPI FilesPost Post /api/2.29/files Create a file copy
HardwareAPI HardwareGet Get /api/2.29/hardware List hardware component information
HardwareAPI HardwarePatch Patch /api/2.29/hardware Modify visual identification
HostGroupsAPI HostGroupsDelete Delete /api/2.29/host-groups Delete a host group
HostGroupsAPI HostGroupsGet Get /api/2.29/host-groups List host groups
HostGroupsAPI HostGroupsHostsDelete Delete /api/2.29/host-groups/hosts Remove a host from a host group
HostGroupsAPI HostGroupsHostsGet Get /api/2.29/host-groups/hosts List host groups that are associated with hosts
HostGroupsAPI HostGroupsHostsPost Post /api/2.29/host-groups/hosts Add a host to a host group
HostGroupsAPI HostGroupsPatch Patch /api/2.29/host-groups Modify a host group
HostGroupsAPI HostGroupsPerformanceByArrayGet Get /api/2.29/host-groups/performance/by-array List host group performance data by array
HostGroupsAPI HostGroupsPerformanceGet Get /api/2.29/host-groups/performance List host group performance data
HostGroupsAPI HostGroupsPost Post /api/2.29/host-groups Create a host group
HostGroupsAPI HostGroupsProtectionGroupsDelete Delete /api/2.29/host-groups/protection-groups Delete a host group from a protection group
HostGroupsAPI HostGroupsProtectionGroupsGet Get /api/2.29/host-groups/protection-groups List host groups that are members of protection groups
HostGroupsAPI HostGroupsProtectionGroupsPost Post /api/2.29/host-groups/protection-groups Create a host group
HostGroupsAPI HostGroupsSpaceGet Get /api/2.29/host-groups/space List host group space information
HostsAPI HostsDelete Delete /api/2.29/hosts Delete a host
HostsAPI HostsGet Get /api/2.29/hosts List hosts
HostsAPI HostsHostGroupsDelete Delete /api/2.29/hosts/host-groups Remove a host from a host group
HostsAPI HostsHostGroupsGet Get /api/2.29/hosts/host-groups List hosts that are associated with host groups
HostsAPI HostsHostGroupsPost Post /api/2.29/hosts/host-groups Add a host to a host group
HostsAPI HostsPatch Patch /api/2.29/hosts Modify a host
HostsAPI HostsPerformanceBalanceGet Get /api/2.29/hosts/performance/balance List host performance balance
HostsAPI HostsPerformanceByArrayGet Get /api/2.29/hosts/performance/by-array List host performance data by array
HostsAPI HostsPerformanceGet Get /api/2.29/hosts/performance List host performance data
HostsAPI HostsPost Post /api/2.29/hosts Create a host
HostsAPI HostsProtectionGroupsDelete Delete /api/2.29/hosts/protection-groups Delete a host from a protection group
HostsAPI HostsProtectionGroupsGet Get /api/2.29/hosts/protection-groups List hosts that are members of protection groups
HostsAPI HostsProtectionGroupsPost Post /api/2.29/hosts/protection-groups Create a host
HostsAPI HostsSpaceGet Get /api/2.29/hosts/space List host space information
KMIPAPI KmipDelete Delete /api/2.29/kmip Delete KMIP server object
KMIPAPI KmipGet Get /api/2.29/kmip List KMIP server objects
KMIPAPI KmipPatch Patch /api/2.29/kmip Modify KMIP attributes
KMIPAPI KmipPost Post /api/2.29/kmip Create KMIP server object
KMIPAPI KmipTestGet Get /api/2.29/kmip/test Lists KMIP connection tests
MaintenanceWindowsAPI MaintenanceWindowsDelete Delete /api/2.29/maintenance-windows Delete maintenance window
MaintenanceWindowsAPI MaintenanceWindowsGet Get /api/2.29/maintenance-windows List maintenance window details
MaintenanceWindowsAPI MaintenanceWindowsPost Post /api/2.29/maintenance-windows Create a maintenance window
NetworkInterfacesAPI NetworkInterfacesDelete Delete /api/2.29/network-interfaces Delete network interface
NetworkInterfacesAPI NetworkInterfacesGet Get /api/2.29/network-interfaces List network interfaces
NetworkInterfacesAPI NetworkInterfacesNeighborsGet Get /api/2.29/network-interfaces/neighbors List network interface neighbors
NetworkInterfacesAPI NetworkInterfacesPatch Patch /api/2.29/network-interfaces Modify network interface
NetworkInterfacesAPI NetworkInterfacesPerformanceGet Get /api/2.29/network-interfaces/performance List network performance statistics
NetworkInterfacesAPI NetworkInterfacesPortDetailsGet Get /api/2.29/network-interfaces/port-details List SFP port details
NetworkInterfacesAPI NetworkInterfacesPost Post /api/2.29/network-interfaces Create network interface
OffloadsAPI OffloadsDelete Delete /api/2.29/offloads Delete offload target
OffloadsAPI OffloadsGet Get /api/2.29/offloads List offload targets
OffloadsAPI OffloadsPost Post /api/2.29/offloads Create offload target
PodReplicaLinksAPI PodReplicaLinksDelete Delete /api/2.29/pod-replica-links Delete pod replica links
PodReplicaLinksAPI PodReplicaLinksGet Get /api/2.29/pod-replica-links List pod replica links
PodReplicaLinksAPI PodReplicaLinksLagGet Get /api/2.29/pod-replica-links/lag List pod replica link lag
PodReplicaLinksAPI PodReplicaLinksPatch Patch /api/2.29/pod-replica-links Modify pod replica links
PodReplicaLinksAPI PodReplicaLinksPerformanceReplicationGet Get /api/2.29/pod-replica-links/performance/replication
PodReplicaLinksAPI PodReplicaLinksPost Post /api/2.29/pod-replica-links Create pod replica links
PodsAPI PodsArraysDelete Delete /api/2.29/pods/arrays Unstretch a pod from an array
PodsAPI PodsArraysGet Get /api/2.29/pods/arrays List pods and their the array members
PodsAPI PodsArraysPost Post /api/2.29/pods/arrays Stretch a pod to an array
PodsAPI PodsDelete Delete /api/2.29/pods Delete a pod
PodsAPI PodsGet Get /api/2.29/pods List pods
PodsAPI PodsPatch Patch /api/2.29/pods Modify a pod
PodsAPI PodsPerformanceByArrayGet Get /api/2.29/pods/performance/by-array List pod performance data by array
PodsAPI PodsPerformanceGet Get /api/2.29/pods/performance List pod performance data
PodsAPI PodsPerformanceReplicationByArrayGet Get /api/2.29/pods/performance/replication/by-array List pod replication performance data by array
PodsAPI PodsPerformanceReplicationGet Get /api/2.29/pods/performance/replication List pod replication performance data
PodsAPI PodsPost Post /api/2.29/pods Create a pod
PodsAPI PodsSpaceGet Get /api/2.29/pods/space List pod space information
PoliciesAPI PoliciesAutodirDelete Delete /api/2.29/policies/autodir Delete auto managed directory policies
PoliciesAPI PoliciesAutodirGet Get /api/2.29/policies/autodir List auto managed directory policies
PoliciesAPI PoliciesAutodirMembersDelete Delete /api/2.29/policies/autodir/members Delete auto managed directory policies
PoliciesAPI PoliciesAutodirMembersGet Get /api/2.29/policies/autodir/members List auto managed directories policy members
PoliciesAPI PoliciesAutodirMembersPost Post /api/2.29/policies/autodir/members Create auto managed directory policies
PoliciesAPI PoliciesAutodirPatch Patch /api/2.29/policies/autodir Modify auto managed directory policies
PoliciesAPI PoliciesAutodirPost Post /api/2.29/policies/autodir Create auto managed directory policies
PoliciesAPI PoliciesGet Get /api/2.29/policies List policies
PoliciesAPI PoliciesMembersGet Get /api/2.29/policies/members List policy members
PoliciesAPI PoliciesNfsClientRulesDelete Delete /api/2.29/policies/nfs/client-rules Delete NFS client policy rules.
PoliciesAPI PoliciesNfsClientRulesGet Get /api/2.29/policies/nfs/client-rules List NFS client policy rules
PoliciesAPI PoliciesNfsClientRulesPost Post /api/2.29/policies/nfs/client-rules Create NFS client policy rules
PoliciesAPI PoliciesNfsDelete Delete /api/2.29/policies/nfs Delete NFS policies
PoliciesAPI PoliciesNfsGet Get /api/2.29/policies/nfs List NFS policies
PoliciesAPI PoliciesNfsMembersDelete Delete /api/2.29/policies/nfs/members Delete NFS policies
PoliciesAPI PoliciesNfsMembersGet Get /api/2.29/policies/nfs/members List NFS policy members
PoliciesAPI PoliciesNfsMembersPost Post /api/2.29/policies/nfs/members Create NFS policies
PoliciesAPI PoliciesNfsPatch Patch /api/2.29/policies/nfs Modify NFS policies
PoliciesAPI PoliciesNfsPost Post /api/2.29/policies/nfs Create NFS policies
PoliciesAPI PoliciesQuotaDelete Delete /api/2.29/policies/quota Delete quota policies
PoliciesAPI PoliciesQuotaGet Get /api/2.29/policies/quota List quota policies
PoliciesAPI PoliciesQuotaMembersDelete Delete /api/2.29/policies/quota/members Delete membership between quota policies and managed directories
PoliciesAPI PoliciesQuotaMembersGet Get /api/2.29/policies/quota/members List quota policy members
PoliciesAPI PoliciesQuotaMembersPost Post /api/2.29/policies/quota/members Create a membership between a managed directory and a quota policy
PoliciesAPI PoliciesQuotaPatch Patch /api/2.29/policies/quota Modify quota policies
PoliciesAPI PoliciesQuotaPost Post /api/2.29/policies/quota Create quota policies
PoliciesAPI PoliciesQuotaRulesDelete Delete /api/2.29/policies/quota/rules Delete quota policy rules
PoliciesAPI PoliciesQuotaRulesGet Get /api/2.29/policies/quota/rules List quota policy rules
PoliciesAPI PoliciesQuotaRulesPatch Patch /api/2.29/policies/quota/rules Modify quota policy rules
PoliciesAPI PoliciesQuotaRulesPost Post /api/2.29/policies/quota/rules Create quota policy rules
PoliciesAPI PoliciesSmbClientRulesDelete Delete /api/2.29/policies/smb/client-rules Delete SMB client policy rules.
PoliciesAPI PoliciesSmbClientRulesGet Get /api/2.29/policies/smb/client-rules List SMB client policy rules
PoliciesAPI PoliciesSmbClientRulesPost Post /api/2.29/policies/smb/client-rules Create SMB client policy rules
PoliciesAPI PoliciesSmbDelete Delete /api/2.29/policies/smb Delete SMB policies
PoliciesAPI PoliciesSmbGet Get /api/2.29/policies/smb List SMB policies
PoliciesAPI PoliciesSmbMembersDelete Delete /api/2.29/policies/smb/members Delete SMB policies
PoliciesAPI PoliciesSmbMembersGet Get /api/2.29/policies/smb/members List SMB policy members
PoliciesAPI PoliciesSmbMembersPost Post /api/2.29/policies/smb/members Create SMB policies
PoliciesAPI PoliciesSmbPatch Patch /api/2.29/policies/smb Modify SMB policies
PoliciesAPI PoliciesSmbPost Post /api/2.29/policies/smb Create SMB policies
PoliciesAPI PoliciesSnapshotDelete Delete /api/2.29/policies/snapshot Delete snapshot policies
PoliciesAPI PoliciesSnapshotGet Get /api/2.29/policies/snapshot List snapshot policies
PoliciesAPI PoliciesSnapshotMembersDelete Delete /api/2.29/policies/snapshot/members Delete snapshot policies
PoliciesAPI PoliciesSnapshotMembersGet Get /api/2.29/policies/snapshot/members List snapshot policy members
PoliciesAPI PoliciesSnapshotMembersPost Post /api/2.29/policies/snapshot/members Create snapshot policies
PoliciesAPI PoliciesSnapshotPatch Patch /api/2.29/policies/snapshot Modify snapshot policies
PoliciesAPI PoliciesSnapshotPost Post /api/2.29/policies/snapshot Create snapshot policies
PoliciesAPI PoliciesSnapshotRulesDelete Delete /api/2.29/policies/snapshot/rules Delete snapshot policy rules
PoliciesAPI PoliciesSnapshotRulesGet Get /api/2.29/policies/snapshot/rules List snapshot policy rules
PoliciesAPI PoliciesSnapshotRulesPost Post /api/2.29/policies/snapshot/rules Create snapshot policy rules
PortsAPI PortsGet Get /api/2.29/ports List ports
PortsAPI PortsInitiatorsGet Get /api/2.29/ports/initiators List port initiators
ProtectionGroupSnapshotsAPI ProtectionGroupSnapshotsDelete Delete /api/2.29/protection-group-snapshots Delete a protection group snapshot
ProtectionGroupSnapshotsAPI ProtectionGroupSnapshotsGet Get /api/2.29/protection-group-snapshots List protection group snapshots
ProtectionGroupSnapshotsAPI ProtectionGroupSnapshotsPatch Patch /api/2.29/protection-group-snapshots Modify a protection group snapshot
ProtectionGroupSnapshotsAPI ProtectionGroupSnapshotsPost Post /api/2.29/protection-group-snapshots Create a protection group snapshot
ProtectionGroupSnapshotsAPI ProtectionGroupSnapshotsReplicaPost Post /api/2.29/protection-group-snapshots/replica Create an action to send protection group snapshots
ProtectionGroupSnapshotsAPI ProtectionGroupSnapshotsTestPost Post /api/2.29/protection-group-snapshots/test Create an attempt to take protection group snapshot
ProtectionGroupSnapshotsAPI ProtectionGroupSnapshotsTransferGet Get /api/2.29/protection-group-snapshots/transfer List protection group snapshots with transfer statistics
ProtectionGroupsAPI ProtectionGroupsDelete Delete /api/2.29/protection-groups Delete a protection group
ProtectionGroupsAPI ProtectionGroupsGet Get /api/2.29/protection-groups List protection groups
ProtectionGroupsAPI ProtectionGroupsHostGroupsDelete Delete /api/2.29/protection-groups/host-groups Delete a host group from a protection group
ProtectionGroupsAPI ProtectionGroupsHostGroupsGet Get /api/2.29/protection-groups/host-groups List protection groups with host group members
ProtectionGroupsAPI ProtectionGroupsHostGroupsPost Post /api/2.29/protection-groups/host-groups Creates an action to add a host group to a protection group
ProtectionGroupsAPI ProtectionGroupsHostsDelete Delete /api/2.29/protection-groups/hosts Delete a host from a protection group
ProtectionGroupsAPI ProtectionGroupsHostsGet Get /api/2.29/protection-groups/hosts List protection groups with host members
ProtectionGroupsAPI ProtectionGroupsHostsPost Post /api/2.29/protection-groups/hosts Create an action to add a host to a protection group
ProtectionGroupsAPI ProtectionGroupsPatch Patch /api/2.29/protection-groups Modify a protection group
ProtectionGroupsAPI ProtectionGroupsPerformanceReplicationByArrayGet Get /api/2.29/protection-groups/performance/replication/by-array List protection group replication performance data with array details
ProtectionGroupsAPI ProtectionGroupsPerformanceReplicationGet Get /api/2.29/protection-groups/performance/replication List protection group replication performance data
ProtectionGroupsAPI ProtectionGroupsPost Post /api/2.29/protection-groups Create a protection group
ProtectionGroupsAPI ProtectionGroupsSpaceGet Get /api/2.29/protection-groups/space List protection group space information
ProtectionGroupsAPI ProtectionGroupsTargetsDelete Delete /api/2.29/protection-groups/targets Delete a target from a protection group
ProtectionGroupsAPI ProtectionGroupsTargetsGet Get /api/2.29/protection-groups/targets List protection groups with targets
ProtectionGroupsAPI ProtectionGroupsTargetsPatch Patch /api/2.29/protection-groups/targets Modify a protection group target
ProtectionGroupsAPI ProtectionGroupsTargetsPost Post /api/2.29/protection-groups/targets Create an action to add a target to a protection group
ProtectionGroupsAPI ProtectionGroupsVolumesDelete Delete /api/2.29/protection-groups/volumes Delete a volume from a protection group
ProtectionGroupsAPI ProtectionGroupsVolumesGet Get /api/2.29/protection-groups/volumes List protection groups with volume members
ProtectionGroupsAPI ProtectionGroupsVolumesPost Post /api/2.29/protection-groups/volumes Create a volume and add it to a protection group
RemotePodsAPI RemotePodsGet Get /api/2.29/remote-pods List remote pods
RemoteProtectionGroupSnapshotsAPI RemoteProtectionGroupSnapshotsDelete Delete /api/2.29/remote-protection-group-snapshots Delete a remote protection group snapshot
RemoteProtectionGroupSnapshotsAPI RemoteProtectionGroupSnapshotsGet Get /api/2.29/remote-protection-group-snapshots List remote protection group snapshots
RemoteProtectionGroupSnapshotsAPI RemoteProtectionGroupSnapshotsPatch Patch /api/2.29/remote-protection-group-snapshots Modify a remote protection group snapshot
RemoteProtectionGroupSnapshotsAPI RemoteProtectionGroupSnapshotsPost Post /api/2.29/remote-protection-group-snapshots Create remote protection group snapshot
RemoteProtectionGroupSnapshotsAPI RemoteProtectionGroupSnapshotsTestPost Post /api/2.29/remote-protection-group-snapshots/test Create an attempt to take remote protection group snapshot
RemoteProtectionGroupSnapshotsAPI RemoteProtectionGroupSnapshotsTransferGet Get /api/2.29/remote-protection-group-snapshots/transfer List remote protection groups with transfer statistics
RemoteProtectionGroupsAPI RemoteProtectionGroupsDelete Delete /api/2.29/remote-protection-groups Eradicate a remote protection group
RemoteProtectionGroupsAPI RemoteProtectionGroupsGet Get /api/2.29/remote-protection-groups List remote protection groups
RemoteProtectionGroupsAPI RemoteProtectionGroupsPatch Patch /api/2.29/remote-protection-groups Manage a remote protection group
RemoteVolumeSnapshotsAPI RemoteVolumeSnapshotsDelete Delete /api/2.29/remote-volume-snapshots Delete a remote volume snapshot
RemoteVolumeSnapshotsAPI RemoteVolumeSnapshotsGet Get /api/2.29/remote-volume-snapshots List remote volume snapshots
RemoteVolumeSnapshotsAPI RemoteVolumeSnapshotsPatch Patch /api/2.29/remote-volume-snapshots Modify a remote volume snapshot
RemoteVolumeSnapshotsAPI RemoteVolumeSnapshotsPost Post /api/2.29/remote-volume-snapshots Create a volume snapshot on a connected remote target or offload target
RemoteVolumeSnapshotsAPI RemoteVolumeSnapshotsTransferGet Get /api/2.29/remote-volume-snapshots/transfer List remote volume snapshots with transfer statistics
SAML2SSOAPI SsoSaml2IdpsDelete Delete /api/2.29/sso/saml2/idps Delete SAML2 SSO configurations
SAML2SSOAPI SsoSaml2IdpsGet Get /api/2.29/sso/saml2/idps List SAML2 SSO configurations
SAML2SSOAPI SsoSaml2IdpsPatch Patch /api/2.29/sso/saml2/idps Modify SAML2 SSO configurations
SAML2SSOAPI SsoSaml2IdpsPost Post /api/2.29/sso/saml2/idps Create SAML2 SSO configurations
SAML2SSOAPI SsoSaml2IdpsTestGet Get /api/2.29/sso/saml2/idps/test List existing SAML2 SSO configurations
SAML2SSOAPI SsoSaml2IdpsTestPatch Patch /api/2.29/sso/saml2/idps/test Modify provided SAML2 SSO configurations
SMISAPI SmiSGet Get /api/2.29/smi-s List SMI-S settings
SMISAPI SmiSPatch Patch /api/2.29/smi-s Modify SLP and SMI-S
SMTPAPI SmtpServersGet Get /api/2.29/smtp-servers List SMTP server attributes
SMTPAPI SmtpServersPatch Patch /api/2.29/smtp-servers Modify SMTP server attributes
SNMPAgentsAPI SnmpAgentsGet Get /api/2.29/snmp-agents List SNMP agent
SNMPAgentsAPI SnmpAgentsMibGet Get /api/2.29/snmp-agents/mib List SNMP agent MIB text
SNMPAgentsAPI SnmpAgentsPatch Patch /api/2.29/snmp-agents Modify SNMP agent
SNMPManagersAPI SnmpManagersDelete Delete /api/2.29/snmp-managers Delete SNMP manager
SNMPManagersAPI SnmpManagersGet Get /api/2.29/snmp-managers List SNMP managers
SNMPManagersAPI SnmpManagersPatch Patch /api/2.29/snmp-managers Modify SNMP manager
SNMPManagersAPI SnmpManagersPost Post /api/2.29/snmp-managers Create SNMP manager
SNMPManagersAPI SnmpManagersTestGet Get /api/2.29/snmp-managers/test List SNMP manager test results
SessionsAPI SessionsGet Get /api/2.29/sessions List session data
SoftwareAPI SoftwareBundleGet Get /api/2.29/software-bundle List software-bundle
SoftwareAPI SoftwareBundlePost Post /api/2.29/software-bundle Create software-bundle
SoftwareAPI SoftwareCheckDelete Delete /api/2.29/software-check Delete a software check task
SoftwareAPI SoftwareCheckGet Get /api/2.29/software-check List software check tasks
SoftwareAPI SoftwareCheckPost Post /api/2.29/software-check Create a software check task
SoftwareAPI SoftwareDelete Delete /api/2.29/software Delete a software package
SoftwareAPI SoftwareGet Get /api/2.29/software List software packages
SoftwareAPI SoftwareInstallationStepsGet Get /api/2.29/software-installation-steps List software upgrade steps
SoftwareAPI SoftwareInstallationsGet Get /api/2.29/software-installations List software upgrades
SoftwareAPI SoftwareInstallationsPatch Patch /api/2.29/software-installations Modify software upgrade
SoftwareAPI SoftwareInstallationsPost Post /api/2.29/software-installations Create a software upgrade
SoftwareAPI SoftwarePatchesCatalogGet Get /api/2.29/software-patches/catalog List available software patches
SoftwareAPI SoftwarePatchesGet Get /api/2.29/software-patches List software patches
SoftwareAPI SoftwarePatchesPost Post /api/2.29/software-patches Create a software patch
SoftwareAPI SoftwarePost Post /api/2.29/software Create a software package
SoftwareAPI SoftwareVersionsGet Get /api/2.29/software-versions List software versions
SubnetsAPI SubnetsDelete Delete /api/2.29/subnets Delete subnet
SubnetsAPI SubnetsGet Get /api/2.29/subnets List subnets
SubnetsAPI SubnetsPatch Patch /api/2.29/subnets Modify subnet
SubnetsAPI SubnetsPost Post /api/2.29/subnets Create subnet
SubscriptionAssetsAPI SubscriptionAssetsGet Get /api/2.29/subscription-assets List subscription assets
SubscriptionsAPI SubscriptionsGet Get /api/2.29/subscriptions List subscriptions
SupportAPI SupportGet Get /api/2.29/support List connection paths
SupportAPI SupportPatch Patch /api/2.29/support Create connection path
SupportAPI SupportTestGet Get /api/2.29/support/test List Everpure Support connection data
SyslogAPI SyslogServersDelete Delete /api/2.29/syslog-servers Delete syslog server
SyslogAPI SyslogServersGet Get /api/2.29/syslog-servers List syslog servers
SyslogAPI SyslogServersPatch Patch /api/2.29/syslog-servers Modify syslog server
SyslogAPI SyslogServersPost Post /api/2.29/syslog-servers Create syslog server
SyslogAPI SyslogServersSettingsGet Get /api/2.29/syslog-servers/settings List syslog settings
SyslogAPI SyslogServersSettingsPatch Patch /api/2.29/syslog-servers/settings Modify syslog settings
SyslogAPI SyslogServersTestGet Get /api/2.29/syslog-servers/test List syslog server test results
VchostsAPI VchostsCertificatesDelete Delete /api/2.29/vchosts/certificates Delete a vchost certificate
VchostsAPI VchostsCertificatesGet Get /api/2.29/vchosts/certificates List vchost certificates
VchostsAPI VchostsCertificatesPatch Patch /api/2.29/vchosts/certificates Modify a vchost certificate
VchostsAPI VchostsCertificatesPost Post /api/2.29/vchosts/certificates Create a vchost certificate
VchostsAPI VchostsDelete Delete /api/2.29/vchosts Delete a vchost
VchostsAPI VchostsEndpointsDelete Delete /api/2.29/vchosts/endpoints Delete a vchost endpoint
VchostsAPI VchostsEndpointsGet Get /api/2.29/vchosts/endpoints List vchost endpoints
VchostsAPI VchostsEndpointsPatch Patch /api/2.29/vchosts/endpoints Modify a vchost endpoint
VchostsAPI VchostsEndpointsPost Post /api/2.29/vchosts/endpoints Create a vchost endpoint
VchostsAPI VchostsGet Get /api/2.29/vchosts List vchosts
VchostsAPI VchostsPatch Patch /api/2.29/vchosts Modify a vchost
VchostsAPI VchostsPost Post /api/2.29/vchosts Create a vchost
VirtualMachinesAPI VirtualMachineSnapshotsGet Get /api/2.29/virtual-machine-snapshots List Virtual Machine Snapshots
VirtualMachinesAPI VirtualMachinesGet Get /api/2.29/virtual-machines List Virtual Machines
VirtualMachinesAPI VirtualMachinesPatch Patch /api/2.29/virtual-machines Update a virtual machine
VirtualMachinesAPI VirtualMachinesPost Post /api/2.29/virtual-machines Create a virtual machine
VolumeGroupsAPI VolumeGroupsDelete Delete /api/2.29/volume-groups Delete a volume group
VolumeGroupsAPI VolumeGroupsGet Get /api/2.29/volume-groups List volume groups
VolumeGroupsAPI VolumeGroupsPatch Patch /api/2.29/volume-groups Modify a volume group
VolumeGroupsAPI VolumeGroupsPerformanceGet Get /api/2.29/volume-groups/performance List volume group performance data
VolumeGroupsAPI VolumeGroupsPost Post /api/2.29/volume-groups Create a volume group
VolumeGroupsAPI VolumeGroupsSpaceGet Get /api/2.29/volume-groups/space List volume group space information
VolumeGroupsAPI VolumeGroupsVolumesGet Get /api/2.29/volume-groups/volumes List volume groups with volumes
VolumeSnapshotsAPI VolumeSnapshotsDelete Delete /api/2.29/volume-snapshots Delete a volume snapshot
VolumeSnapshotsAPI VolumeSnapshotsGet Get /api/2.29/volume-snapshots List volume snapshots
VolumeSnapshotsAPI VolumeSnapshotsPatch Patch /api/2.29/volume-snapshots Modify a volume snapshot
VolumeSnapshotsAPI VolumeSnapshotsPost Post /api/2.29/volume-snapshots Create a volume snapshot
VolumeSnapshotsAPI VolumeSnapshotsTagsBatchPut Put /api/2.29/volume-snapshots/tags/batch Update tags
VolumeSnapshotsAPI VolumeSnapshotsTagsDelete Delete /api/2.29/volume-snapshots/tags Delete tags
VolumeSnapshotsAPI VolumeSnapshotsTagsGet Get /api/2.29/volume-snapshots/tags List tags
VolumeSnapshotsAPI VolumeSnapshotsTestPost Post /api/2.29/volume-snapshots/test Create the volume snapshot path
VolumeSnapshotsAPI VolumeSnapshotsTransferGet Get /api/2.29/volume-snapshots/transfer List volume snapshots with transfer statistics
VolumesAPI VolumesDelete Delete /api/2.29/volumes Delete a volume
VolumesAPI VolumesDiffGet Get /api/2.29/volumes/diff List volume diffs
VolumesAPI VolumesGet Get /api/2.29/volumes List volumes
VolumesAPI VolumesPatch Patch /api/2.29/volumes Modify a volume
VolumesAPI VolumesPerformanceByArrayGet Get /api/2.29/volumes/performance/by-array List volume performance data by array
VolumesAPI VolumesPerformanceGet Get /api/2.29/volumes/performance List volume performance data
VolumesAPI VolumesPost Post /api/2.29/volumes Create a volume
VolumesAPI VolumesProtectionGroupsDelete Delete /api/2.29/volumes/protection-groups Delete a volume from a protection group
VolumesAPI VolumesProtectionGroupsGet Get /api/2.29/volumes/protection-groups List volumes that are members of protection groups
VolumesAPI VolumesProtectionGroupsPost Post /api/2.29/volumes/protection-groups Create a volume and add it to a protection group
VolumesAPI VolumesSpaceGet Get /api/2.29/volumes/space List volume space information
VolumesAPI VolumesTagsBatchPut Put /api/2.29/volumes/tags/batch Update tags
VolumesAPI VolumesTagsDelete Delete /api/2.29/volumes/tags Delete tags
VolumesAPI VolumesTagsGet Get /api/2.29/volumes/tags List tags
VolumesAPI VolumesVolumeGroupsGet Get /api/2.29/volumes/volume-groups List volumes that are in volume groups

Documentation For Models

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime