PureStorage.Rest.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>PureStorage.Rest</name> </assembly> <members> <member name="F:PureStorage.Rest.PureOperations.NAMESPACE_REGEX"> <summary> Regex describing how to determine if the name breaks backwards compat </summary> </member> <member name="T:PureStorage.Rest.PureInternalsOperationsStubImpl"> <summary> Class representing the operations on a protection group. </summary> </member> <member name="F:PureStorage.Rest.PhoneHomeManager.PHONEHOME_MIN_REST_VERSION"> <summary> The minimum REST API needed to support PhoneHome integration with plugins </summary> </member> <member name="F:PureStorage.Rest.PhoneHomeManager.BACKGROUND_THREAD_WAIT_TIME"> <summary> How many ms to wait for background thread to flush any messages </summary> </member> <member name="M:PureStorage.Rest.PhoneHomeManager.#ctor(PureStorage.Rest.PureRestClient,PureStorage.Rest.PureLogger,PureStorage.Rest.PhoneHomeManagerConfig)"> <summary> Constructor </summary> <param name="client"></param> <param name="logger">used to log messages to local machine</param> <param name="phConfig"></param> </member> <member name="M:PureStorage.Rest.PhoneHomeManager.Log(PureStorage.Rest.PhoneHomeLog)"> <summary> TODO: remove this and use the implmentation of the Interals.GetMV().Log() method when we move to support 1.5 in the REST library </summary> <param name="message"></param> <returns></returns> </member> <member name="M:PureStorage.Rest.PhoneHomeManager.LogPhoneHomeMessages(System.Collections.Generic.IList{PureStorage.Rest.PhoneHomeLog})"> <summary> Asynchronously write custom messages for Array to PhoneHome </summary> <param name="messages"></param> </member> <member name="T:PureStorage.Rest.ClientInfo"> <summary> Information of the client using the REST library. </summary> </member> <member name="F:PureStorage.Rest.PureUserRole.Readonly"> <summary> Readonly role. </summary> </member> <member name="F:PureStorage.Rest.PureUserRole.StorageAdmin"> <summary> Storage Administrator role. </summary> </member> <member name="F:PureStorage.Rest.PureUserRole.ArrayAdmin"> <summary> Array admin role. </summary> </member> <member name="T:PureStorage.Rest.MetricTimeRange"> <summary> Class representing all the supported time ranges. </summary> </member> <member name="P:PureStorage.Rest.MetricTimeRange.PT1H"> <summary> Gets the 1-hour time range. </summary> </member> <member name="P:PureStorage.Rest.MetricTimeRange.PT3H"> <summary> Gets the 3-hour time range. </summary> </member> <member name="P:PureStorage.Rest.MetricTimeRange.P24H"> <summary> Gets the 24-hour time range. </summary> </member> <member name="P:PureStorage.Rest.MetricTimeRange.P7D"> <summary> Gets the 7-day time range. </summary> </member> <member name="P:PureStorage.Rest.MetricTimeRange.P30D"> <summary> Gets the 30-day time range. </summary> </member> <member name="P:PureStorage.Rest.MetricTimeRange.P90D"> <summary> Gets the 90-day time range. </summary> </member> <member name="P:PureStorage.Rest.MetricTimeRange.P1Y"> <summary> Gets the 1-year time range. </summary> </member> <member name="T:PureStorage.Rest.PureArrayOperationsStubImpl"> <summary> Class representing the array operations. </summary> </member> <member name="M:PureStorage.Rest.PureArrayOperationsStubImpl.GetId(System.String,System.Boolean,System.String)"> <summary> Gets the id of the array. </summary> </member> <member name="M:PureStorage.Rest.PureArrayOperationsStubImpl.SetPhoneHomeStatus(System.String,System.Boolean,PureStorage.Rest.PureArrayStatus,System.String)"> <summary> Sets the phonehome status. </summary> </member> <member name="M:PureStorage.Rest.PureArrayOperationsStubImpl.SetConsoleLock(System.String,System.Boolean,PureStorage.Rest.PureArrayStatus,System.String)"> <summary> Sets the status of the console. </summary> </member> <member name="M:PureStorage.Rest.PureArrayOperationsStubImpl.SetSyslogServers(System.String,System.Boolean,System.Collections.Generic.IList{System.String},System.String)"> <summary> Sets the syslog servers. </summary> </member> <member name="T:PureStorage.Rest.PureRestErrorCode"> <summary> Error codes offering detail information. </summary> </member> <member name="F:PureStorage.Rest.PureRestErrorCode.InternalError"> <summary> Internal error. </summary> </member> <member name="F:PureStorage.Rest.PureRestErrorCode.InvalidCredentials"> <summary> Invalid credential. </summary> </member> <member name="F:PureStorage.Rest.PureRestErrorCode.ArgumentNull"> <summary> Null argument is passed in. </summary> </member> <member name="F:PureStorage.Rest.PureRestErrorCode.AlreadyExists"> <summary> The entity already exists. </summary> </member> <member name="F:PureStorage.Rest.PureRestErrorCode.InvalidArgument"> <summary> Invalid argument, e.g. negative size. </summary> </member> <member name="F:PureStorage.Rest.PureRestErrorCode.ArgumentMissing"> <summary> Some required argument is not passed in. </summary> </member> <member name="F:PureStorage.Rest.PureRestErrorCode.InvalidVersion"> <summary> API version is invalid. </summary> </member> <member name="F:PureStorage.Rest.PureRestErrorCode.InvalidOperation"> <summary> This operation is invalid, e.g. recover a volume that has not be destroyed, or destroy a volume that is already destroyed. </summary> </member> <member name="F:PureStorage.Rest.PureRestErrorCode.NotExist"> <summary> The entity does not exist. </summary> </member> <member name="F:PureStorage.Rest.PureRestErrorCode.ServiceUnavailable"> <summary> The service is not available. </summary> </member> <member name="F:PureStorage.Rest.PureRestErrorCode.Unauthorized"> <summary> The operation is not authorized. </summary> </member> <member name="F:PureStorage.Rest.PureRestErrorCode.InvalidLUNNumber"> <summary> The LUN number provided for the host to volume connection was invalid. </summary> </member> <member name="T:PureStorage.Rest.PureRestException"> <summary> Class for Exceptions from the Pure rest client. </summary> </member> <member name="M:PureStorage.Rest.PureRestException.#ctor"> <summary> Constructs a pure rest exception. The error code defaults to internal error. </summary> </member> <member name="M:PureStorage.Rest.PureRestException.#ctor(System.Net.HttpStatusCode,PureStorage.Rest.PureRestErrorCode,System.Exception)"> <summary> Constructs a pure rest exception. </summary> <param name="statusCode">The http status code.</param> <param name="errorCode">The error code.</param> <param name="innerException">The inner exception.</param> </member> <member name="M:PureStorage.Rest.PureRestException.#ctor(System.Net.HttpStatusCode,PureStorage.Rest.PureRestErrorCode,System.Collections.Generic.IList{PureStorage.Rest.PureRestErrorDetail},System.String,System.Exception)"> <summary> Constructs a pure rest exception. </summary> <param name="statusCode">The status code.</param> <param name="errorCode">The pure rest error code.</param> <param name="details">The pure rest error details.</param> <param name="response">The pure rest error response.</param> <param name="innerException">The inner exception.</param> </member> <member name="P:PureStorage.Rest.PureRestException.HttpStatusCode"> <summary> Gets the http status code of the rest exception. </summary> </member> <member name="P:PureStorage.Rest.PureRestException.ErrorCode"> <summary> Gets the detail error code for this exception. </summary> </member> <member name="P:PureStorage.Rest.PureRestException.Details"> <summary> Gets the detail error information. </summary> </member> <member name="P:PureStorage.Rest.PureRestException.Response"> <summary> Gets the detail error information. </summary> </member> <member name="T:PureStorage.Rest.PureProtectionGroupOperationsStubImpl"> <summary> Class representing the operations on a protection group. </summary> </member> <member name="M:PureStorage.Rest.PureProtectionGroupOperationsStubImpl.SetSchedule(System.String,System.Boolean,System.String,System.Collections.Generic.IList{PureStorage.Rest.Blackout},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String)"> <summary> Sets the replication and snapshot schedule in the protection group. </summary> <returns>The schedule.</returns> </member> <member name="M:PureStorage.Rest.PureProtectionGroupOperationsStubImpl.CreateSnapshot(System.String,System.Boolean,System.String,System.Boolean,System.Boolean,System.Boolean,System.String,System.String)"> <summary> Create snapshot for the protection group. </summary> <param name="api_version">The version of the api.</param> <param name="offline">Whether to only create the request</param> <param name="protectionGroupName">The protection group.</param> <param name="applyRetention">Apply retention to the snapshots created.</param> <param name="replicateNow">Replicate the snapshots immediately.</param> <param name="replicate">Replicate to each allowed target after all earlier replication sessions for the same protection group have been completed to that target.</param> <param name="suffix">Suffix for the snapshots.</param> <param name="operationID">Supplied by the caller to correlate multiple sub-operations.</param> <returns>The snapshot.</returns> </member> <member name="M:PureStorage.Rest.PureProtectionGroupOperationsStubImpl.CreateSnapshot(System.String,System.Boolean,System.Collections.Generic.IList{System.String},System.Boolean,System.Boolean,System.Boolean,System.String,System.String)"> <summary> Create snapshot for the protection group. </summary> <param name="api_version">The version of the api.</param> <param name="offline">Whether to only create the request</param> <param name="protectionGroupNames">The protection groups.</param> <param name="applyRetention">Apply retention to the snapshots created.</param> <param name="replicateNow">Replicate the snapshots immediately.</param> <param name="replicate">Replicate to each allowed target after all earlier replication sessions for the same protection group have been completed to that target.</param> <param name="suffix">Suffix for the snapshots.</param> <param name="operationID">Supplied by the caller to correlate multiple sub-operations.</param> <returns>The snapshot.</returns> </member> <member name="M:PureStorage.Rest.PureProtectionGroupOperationsStubImpl.GetChildSnapshots(System.String,System.Boolean,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String)"> <summary> Gets the volume snapshots that are part of the protection group or protection group snapshot </summary> <param name="api_version"></param> <param name="offline"></param> <param name="pGroupSnapshotName">protection group or protection group snapshot</param> <param name="filter"></param> <param name="sort"></param> <param name="startElement"></param> <param name="pageSize"></param> <param name="operationID"></param> <returns></returns> </member> <member name="F:PureStorage.Rest.PureSizeUnit.S"> <summary> 512-byte </summary> </member> <member name="F:PureStorage.Rest.PureSizeUnit.KiB"> <summary> Kibibyte </summary> </member> <member name="F:PureStorage.Rest.PureSizeUnit.MiB"> <summary> Mebibyte </summary> </member> <member name="F:PureStorage.Rest.PureSizeUnit.GiB"> <summary> Gibibyte </summary> </member> <member name="F:PureStorage.Rest.PureSizeUnit.TiB"> <summary> Tebibyte </summary> </member> <member name="F:PureStorage.Rest.PureSizeUnit.PiB"> <summary> Pebibyte </summary> </member> <member name="T:PureStorage.Rest.PureVolumeOperationsStubImpl"> <summary> Implementation of Volume stubs. </summary> </member> <member name="M:PureStorage.Rest.PureVolumeOperationsStubImpl.Create(System.String,System.Boolean,System.String,System.Int64,System.String,System.Boolean,System.String)"> <summary> Create a volume. </summary> <param name="api_version">The version of the api.</param> <param name="offline">Whether to only create the request.</param> <param name="volumeName">The name of the volume.</param> <param name="size">The size of the volume.</param> <param name="unit">The unit of the volume size.</param> <param name="overwrite">Overwrite existing volume if set to true.</param> <param name="operationID">Supplied by the caller to correlate multiple sub-operations.</param> <returns>The volume wrapped in a RequestResult object.</returns> </member> <member name="T:PureStorage.Rest.PureLogger.EventId"> <summary> EventId. </summary> </member> <member name="T:PureStorage.Rest.PureNamespacedPropertyAttribute"> <summary> Attribute describing a request to the rest API. </summary> </member> <member name="T:PureStorage.Rest.PureNamespacedResponseAttribute"> <summary> Attribute describing a request to the rest API. </summary> </member> <member name="T:PureStorage.Rest.PureRequestAttribute"> <summary> Attribute describing a request to the rest API. </summary> </member> <member name="T:PureStorage.Rest.PureRequestParamAttribute"> <summary> Attribute describing the query parameters in the request Uri. </summary> </member> <member name="P:PureStorage.Rest.PureRequestParamAttribute.Order"> <summary> Gets or sets the order of the annotated property in the request URI format string. </summary> </member> <member name="P:PureStorage.Rest.PureRequestParamAttribute.ParameterName"> <summary> Gets or sets the parameter name of this parameter. This attribute cannot be used if the Order attribute is set. </summary> </member> <member name="T:PureStorage.Rest.PureRestClient"> <summary> The client to the REST API </summary> </member> <member name="T:PureStorage.Rest.PureRestClientBase"> <summary> Class for the basic Http client. </summary> </member> <member name="M:PureStorage.Rest.PureRestClientBase.SendWithRetryAndErrorHandling(System.String,System.String,PureStorage.Rest.PureRequest)"> <summary> Send a web request with optional retrys. The method will throw PureRestException if the request fails in the end. </summary> </member> <member name="M:PureStorage.Rest.PureRestClientBase.SendWithRetryAndErrorHandling(System.String,System.String,PureStorage.Rest.PureRequest,System.Int32)"> <summary> Send a web request with optional retrys. The method will throw PureRestException if the request fails in the end. </summary> </member> <member name="M:PureStorage.Rest.PureRestClientBase.Dispose"> <summary> Dispose the client, by terminating the session. </summary> <remarks> We don't have the dispose logic in finalizer because terminating the session could throw exception and cause the appDomain to crash. The session timeout anyways. So we only do the disposable for the proactive cleanups. </remarks> </member> <member name="P:PureStorage.Rest.PureRestClientBase.OperationID"> <summary> Gets the operationID sent as X-Operation-Id header with each request. This is used to link multiple REST operations as part of the same client task. </summary> </member> <member name="P:PureStorage.Rest.PureRestClientBase.ArraySupportedApis"> <summary> Gets the API versions supported by the Array </summary> </member> <member name="P:PureStorage.Rest.PureRestClientBase.RestApiVersion"> <summary> Gets the REST API version used by this client </summary> </member> <member name="P:PureStorage.Rest.PureRestClientBase.PhoneHomeHttpEndPoint"> <summary> The PhoneHome functionality only works with REST 1.5+ , so the PhoneHome endpoint may be different from HttpEndpoint </summary> </member> <member name="P:PureStorage.Rest.PureRestClientBase.HttpEndpoint"> <summary> Gets the http endpoint that this client is talking to. </summary> </member> <member name="P:PureStorage.Rest.PureRestClientBase.Username"> <summary> Gets the username used by this client </summary> </member> <member name="P:PureStorage.Rest.PureRestClientBase.ApiToken"> <summary> Gets the API Token that this client is using to communicate with the FlashArray. </summary> </member> <member name="P:PureStorage.Rest.PureRestClientBase.Role"> <summary> Gets or sets the role that this client is running with. </summary> </member> <member name="P:PureStorage.Rest.PureRestClientBase.SupportedVersions"> <summary> Gets the list of supported versions. </summary> </member> <member name="M:PureStorage.Rest.PureRestClient.Create(System.String,System.String,System.String,System.String,PureStorage.Rest.PureRestClientOptions,PureStorage.Rest.PhoneHomeManagerConfig)"> <summary> Create a rest client </summary> <param name="username">The username for the array</param> <param name="password">The password</param> <param name="apiEndpoint">The API endpoint, e.g. "192.168.231.101" </param> <param name="version">Version to use. Pass in null if you need to use the latest one supported. </param> <param name="options">The rest client options.</param> <param name="phConfig">The configuration settings for the PhoneHome logger</param> <returns></returns> </member> <member name="M:PureStorage.Rest.PureRestClient.Create(System.String,System.String,System.String,PureStorage.Rest.PureRestClientOptions,PureStorage.Rest.PhoneHomeManagerConfig)"> <summary> Create a rest client </summary> <param name="apiToken">The apiToken for the array</param> <param name="apiEndpoint">The API endpoint, e.g. "192.168.231.101" </param> <param name="version">Version to use. Pass in null if you need to use the latest one supported. </param> <param name="options">The rest client options.</param> <param name="phConfig">The configuration settings for the PhoneHome logger</param> <returns></returns> </member> <member name="M:PureStorage.Rest.PureRestClient.StartOperation(System.String)"> <summary> Sets the X-Operation-Id header sent with each request. This is used to link multiple REST operations as part of the same client task. </summary> <param name="operationID"></param> <returns>The operationID</returns> </member> <member name="M:PureStorage.Rest.PureRestClient.EndOperation"> <summary> Removes the X-Operation-Id header being sent with each request. </summary> </member> <member name="M:PureStorage.Rest.PureRestClient.GetEndPointAbsoluteURIString(System.String)"> <summary> Return a valid URL from the input endpoint Acceptable: Valid IPv4 or IPv6 address Valid absolute URI with http or https schemes Valid DNS hostname string Not acceptable: IP address but not IPv4 or IPv6 Hostname that is not a DNS host type URI with invalid scheme, hostname or not absolute </summary> <param name="inputEndPoint"></param> <returns></returns> </member> <member name="M:PureStorage.Rest.PureRestClient.GetEndPointAbsoluteURI(System.String)"> <summary> Return a valid URL from the input endpoint Acceptable: Valid IPv4 or IPv6 address Valid absolute URI with http or https schemes Valid DNS hostname string Not acceptable: IP address but not IPv4 or IPv6 Hostname that is not a DNS host type URI with invalid scheme, hostname or not absolute </summary> <param name="inputEndPoint"></param> <returns></returns> </member> <member name="M:PureStorage.Rest.PureRestClient.GetEndPointForFlashArray(System.String)"> <summary> We will use https as the method and /api as the base relative path </summary> <param name="inputEndPoint"></param> <returns></returns> </member> <member name="P:PureStorage.Rest.PureRestClient.Array"> <summary> Gets the array Operations </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.Volumes"> <summary> Gets the volume operations </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.VolumeGroups"> <summary> Gets the vgroup operations </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.Hosts"> <summary> Gets the host operations </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.HostGroups"> <summary> Gets the host group operations </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.ProtectionGroups"> <summary> Gets the protection group operations </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.Pods"> <summary> Gets the pod operations </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.Ports"> <summary> Gets the port operations. </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.Alerts"> <summary> Gets the alert operations. </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.Messages"> <summary> Gets the message operations. </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.SNMP"> <summary> Gets the SNMP operations. </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.Certificates"> <summary> Gets the certificate operations. </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.Networking"> <summary> Gets the networking operations </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.Hardware"> <summary> Gets the hardware operations </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.Internals"> <summary> Gets the internal operations </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.Users"> <summary> Gets the user operations </summary> </member> <member name="P:PureStorage.Rest.PureRestClient.KMIP"> <summary> Gets the KMIP operations </summary> </member> <member name="T:PureStorage.Rest.PureRestClientOptions"> <summary> The rest client options. </summary> </member> <member name="P:PureStorage.Rest.PureRestClientOptions.NoOfRetries"> <summary> How many times to retry on network failure </summary> </member> <member name="P:PureStorage.Rest.PureRestClientOptions.RetryIntervalBase"> <summary> The time (in ms) to wait before retrying a web request. Only retries on network issues, not for Http errors. Default value is 50. </summary> </member> <member name="P:PureStorage.Rest.PureRestClientOptions.RetryIntervalGrowthFactor"> <summary> The growth factor of the retryIntervalBase for subsequent retries Default value is 3. </summary> </member> <member name="P:PureStorage.Rest.PureRestClientOptions.IgnoreCertificateError"> <summary> Gets or sets the value indicating if the server certificate errors should be ignored. Default value is false. </summary> </member> <member name="P:PureStorage.Rest.PureRestClientOptions.HttpTimeoutInMilliseconds"> <summary> Gets or sets the timeout value for the http requests. Default is 5000 milliseconds. </summary> </member> <member name="P:PureStorage.Rest.PureRestClientOptions.ClientInfo"> <summary> Gets or sets the client info. This will be included as the product token in the HTTP User Agent header. Default is "PureRestClient/{AssemblyVersion}". </summary> </member> <member name="P:PureStorage.Rest.PureRestClientOptions.RoleRequired"> <summary> Gets or sets the role requird by this client instance, e.g. Readonly, StorageAdmin, or ArrayAdmin. </summary> <remarks> If the user cannot be granted this role, a PureException will be thrown. </remarks> </member> <member name="T:PureStorage.Rest.Strings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PureStorage.Rest.Strings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PureStorage.Rest.Strings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PureStorage.Rest.Strings.ExceptionTrace"> <summary> Looks up a localized string similar to "PureRestException: HttpStatusCode = '{0}', RestErrorCode = '{1}', Details = '{2}', InnerException = '{3}'". </summary> </member> <member name="P:PureStorage.Rest.Strings.InnerException"> <summary> Looks up a localized string similar to Inner Exception='{0}'. </summary> </member> <member name="P:PureStorage.Rest.Strings.ObjectDisposed"> <summary> Looks up a localized string similar to This PureRestClient is already disposed.. </summary> </member> <member name="P:PureStorage.Rest.Strings.OnlyOneBlackoutAllowed"> <summary> Looks up a localized string similar to Only one black out period is allowed. . </summary> </member> <member name="P:PureStorage.Rest.Strings.PurityMessage"> <summary> Looks up a localized string similar to Message from Purity='ctx:{0},msg:{1}'. </summary> </member> <member name="P:PureStorage.Rest.Strings.UserRoleUnrecognized"> <summary> Looks up a localized string similar to The user role is not recognized: '{0}'. </summary> </member> <member name="M:PureStorage.Rest.Utils.Convert(PureStorage.Rest.RemoteAssistStatus)"> <summary> Convert between equivalent PureArrayStatus and RemoteAssistStatus This is needed because of a discrepancy in the REST API Get receive "enabled"/"disabled", but PUT expects "connect"/"disconnect". </summary> <param name="status"></param> <returns></returns> </member> <member name="M:PureStorage.Rest.Utils.Convert(PureStorage.Rest.PureArrayStatus)"> <summary> Convert between equivalent PureArrayStatus and RemoteAssistStatus This is needed because of a discrepancy in the REST API Get receive "enabled"/"disabled", but PUT expects "connect"/"disconnect" </summary> <param name="status"></param> <returns></returns> </member> <member name="M:PureStorage.Rest.Utils.CompareRestApiVersions(System.String,System.String)"> <summary> Compares REST API versions. Since this is called internally, we assume valid REST API versions are passed </summary> <param name="left"></param> <param name="right"></param> <returns>returns +ve number if left is bigger, zero if left == right, negative if left is smaller</returns> </member> </members> </doc> |