NebSharp.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>NebSharp</name> </assembly> <members> <member name="T:NebSharp.Core.ConsoleLogger"> <summary> Implementation of ILogger that writes to the Console output. </summary> </member> <member name="M:NebSharp.Core.ConsoleLogger.#ctor(NebSharp.LogSeverity)"> <summary> Instantiate a new logger that writes to the standard console. </summary> <param name="logLevel">Logging level</param> </member> <member name="M:NebSharp.Core.ConsoleLogger.#ctor"> <summary> Instantiate a new logger that writes to the standard console. </summary> </member> <member name="P:NebSharp.Core.ConsoleLogger.LogLevel"> <summary> Logging level for this instance of a log writer. </summary> </member> <member name="M:NebSharp.Core.ConsoleLogger.WriteDebug(System.String)"> <summary> Write a debuging message. </summary> <param name="message"> The message to print </param> </member> <member name="M:NebSharp.Core.ConsoleLogger.WriteError(System.String)"> <summary> Write an error message </summary> <param name="message"> The error message to print </param> </member> <member name="M:NebSharp.Core.ConsoleLogger.WriteProgress(System.String,System.Int32)"> <summary> Write a progress update </summary> <param name="activity"> The name of the activity that is updated </param> <param name="percent"> The current activity status in percent (0-100) </param> </member> <member name="M:NebSharp.Core.ConsoleLogger.WriteVerbose(System.String)"> <summary> Write a verbose message </summary> <param name="message"> The message to print </param> </member> <member name="M:NebSharp.Core.ConsoleLogger.WriteWarning(System.String)"> <summary> Write a warning message </summary> <param name="message"> The message to print </param> </member> <member name="M:NebSharp.Core.ConsoleLogger.GetTimestamp"> <summary> Returns the current date and time in the format [yyyy-MM-dd HH:mm:ss]. This uses the local time zone of the user's computer. </summary> <returns> Current date and time in a standard format. </returns> </member> <member name="T:NebSharp.Core.ILogger"> <summary> Interface definition for log output. </summary> </member> <member name="P:NebSharp.Core.ILogger.LogLevel"> <summary> Logging level for this instance of a log writer. </summary> </member> <member name="M:NebSharp.Core.ILogger.WriteDebug(System.String)"> <summary> Write a debuging message. </summary> <param name="message"> The message to print </param> </member> <member name="M:NebSharp.Core.ILogger.WriteVerbose(System.String)"> <summary> Write a verbose message </summary> <param name="message"> The message to print </param> </member> <member name="M:NebSharp.Core.ILogger.WriteWarning(System.String)"> <summary> Write a warning message </summary> <param name="message"> The message to print </param> </member> <member name="M:NebSharp.Core.ILogger.WriteError(System.String)"> <summary> Write an error message </summary> <param name="message"> The error message to print </param> </member> <member name="M:NebSharp.Core.ILogger.WriteProgress(System.String,System.Int32)"> <summary> Write a progress update </summary> <param name="activity"> The name of the activity that is updated </param> <param name="percent"> The current activity status in percent (0-100) </param> </member> <member name="T:NebSharp.Core.NebException"> <summary> Wrapper for standard System.Exception for nebulon specific errors. </summary> </member> <member name="M:NebSharp.Core.NebException.#ctor"> <summary> Instanciate a new NebException </summary> </member> <member name="M:NebSharp.Core.NebException.#ctor(System.String)"> <summary> Instanciate a new NebException </summary> <param name="message">Message describing the error</param> </member> <member name="M:NebSharp.Core.NebException.#ctor(System.String,System.Exception)"> <summary> Instanciate a new NebException </summary> <param name="message">Message describing the error</param> <param name="innerException"></param> </member> <member name="T:NebSharp.GraphQLMethodType"> <summary> GraphQL method types supported by UCAPI </summary> </member> <member name="T:NebSharp.GraphQLParameters"> <summary> Parameter definition for a GraphQL command (mutation or query). </summary> </member> <member name="F:NebSharp.GraphQLParameters.MAX_RECURSION_DEPTH"> <summary> Defines the maximum recursion depth when resolving parameters. </summary> </member> <member name="M:NebSharp.GraphQLParameters.Add(System.String,System.Object,System.Boolean)"> <summary> Adds the specified key and value to the dictionary if the value is not null and optional is set to true, the element will not be added. </summary> <param name="key"> The key of the element to add </param> <param name="value"> The value of the element to add </param> <param name="optional"> If true, the element will not be added when the value is null </param> </member> <member name="M:NebSharp.GraphQLParameters.ToString"> <summary> Convert the GraphQLParameter object to a string representation </summary> <returns></returns> </member> <member name="T:NebSharp.Types.JsonPath"> <summary> Allows specifying the JSONPath expression for a class property for serialization and deserialization of a class. </summary> </member> <member name="M:NebSharp.Types.JsonPath.#ctor(System.String,System.Boolean)"> <summary> Constructs a new JsonPath attribute </summary> <param name="path"> JSONPath, e.g. "$.key" </param> <param name="mandatory"> Indicates if the value in the specified path must be provided </param> </member> <member name="P:NebSharp.Types.JsonPath.BasePath"> <summary> Base path for the variable. For e.g. <b>$.name.something</b> it will be <b>name</b>. </summary> </member> <member name="P:NebSharp.Types.JsonPath.GraphQLName"> <summary> The JSON Path property as a GraphQL hierarchy </summary> </member> <member name="P:NebSharp.Types.JsonPath.Mandatory"> <summary> Indicates if the parameter must be set </summary> </member> <member name="P:NebSharp.Types.JsonPath.Path"> <summary> JSON path for the variable. </summary> </member> <member name="M:NebSharp.Types.JsonPath.GetJsonPathAttribute(System.Reflection.PropertyInfo)"> <summary> Get the JsonPath attribute from a property. If there are multiple attributes specified, only the first attribute is returned. If no attribute is found, then null is returned. </summary> <param name="propertyInfo"></param> <returns></returns> </member> <member name="M:NebSharp.Types.JsonPath.GetJsonPathProperties(System.Object)"> <summary> Gets the list of class properties that have a JsonPath attribute. </summary> <param name="value"> The object from which to retrieve the properties </param> <returns></returns> </member> <member name="M:NebSharp.Types.JsonPath.GetJsonPathProperties(System.Type)"> <summary> Gets the list of class properties that have a JsonPath attribute. </summary> <param name="valueType"> The type from which to retrieve the properties </param> <returns></returns> </member> <member name="T:NebSharp.Types.AlertSeverity"> <summary> Severity of an alert </summary> </member> <member name="F:NebSharp.Types.AlertSeverity.Unknown"> <summary> Alert severity is not known </summary> </member> <member name="F:NebSharp.Types.AlertSeverity.Urgent"> <summary> Alert severity indicates complete loss of functionality or data unavailability and requires immediate attention by service owners </summary> </member> <member name="F:NebSharp.Types.AlertSeverity.Critical"> <summary> Alert severity indicates complete loss of functionality or data unavailability and requires immediate attention by service owners </summary> </member> <member name="F:NebSharp.Types.AlertSeverity.Major"> <summary> Alert severity indicates that there is partial loss of functionality or partial data unavailability, no redundancy in a service (failure of one more resource will cause an outage) and requires immediate attention by service owners </summary> </member> <member name="F:NebSharp.Types.AlertSeverity.Minor"> <summary> Alert severity indicates that there is no loss in functionality, performance and stability issues that require attention by service owners </summary> </member> <member name="F:NebSharp.Types.AlertSeverity.Trivial"> <summary> Alert severity indicates that there is no loss in functionality, only minor impacts to performance, or cosmetic issues or bugs, not affecting the customer's ability to use the product </summary> </member> <member name="T:NebSharp.Types.AlertStatus"> <summary> Status of an alert </summary> </member> <member name="F:NebSharp.Types.AlertStatus.Unknown"> <summary> Status of the alert is not known </summary> </member> <member name="F:NebSharp.Types.AlertStatus.Open"> <summary> The alert is not resolved </summary> </member> <member name="F:NebSharp.Types.AlertStatus.Closed"> <summary> The alert is resolved </summary> </member> <member name="T:NebSharp.Types.Alert"> <summary> Instance of an alert in nebulon ON An alert represents an issue in nebulon ON or your infrastructure. If the alert is reporting a status of ``Open`` it is an active alert in your environment that may require immediate attention.If it is reporting ``Closed`` the issue was resolved. </summary> </member> <member name="P:NebSharp.Types.Alert.ActionOperation"> <summary> Action that can be exectuted from this alert </summary> </member> <member name="P:NebSharp.Types.Alert.ActionParameters"> <summary> Parameters fort he action that can be executed from this alert. </summary> </member> <member name="P:NebSharp.Types.Alert.Code"> <summary> Alert code allows the unique identification of an alert type </summary> </member> <member name="P:NebSharp.Types.Alert.CorrectiveActions"> <summary> List of recommended corrective actions that a user can perform </summary> </member> <member name="P:NebSharp.Types.Alert.CreateTime"> <summary> Timestamp for when the alert was detected </summary> </member> <member name="P:NebSharp.Types.Alert.Details"> <summary> Detailed description for the alert </summary> </member> <member name="P:NebSharp.Types.Alert.EventId"> <summary> Unique identifier of the event (Open or Close) </summary> </member> <member name="P:NebSharp.Types.Alert.IncidentGuid"> <summary> Unique identifier of the incident </summary> </member> <member name="P:NebSharp.Types.Alert.NPodGuid"> <summary> Related nPod identifier </summary> </member> <member name="P:NebSharp.Types.Alert.ResourceId"> <summary> Related resource identifier </summary> </member> <member name="P:NebSharp.Types.Alert.ResourceName"> <summary> Related resource name </summary> </member> <member name="P:NebSharp.Types.Alert.ResourceType"> <summary> Related resource type </summary> </member> <member name="P:NebSharp.Types.Alert.Severity"> <summary> Severity of the alert </summary> </member> <member name="P:NebSharp.Types.Alert.SpuSerial"> <summary> Related services processing unit serial number </summary> </member> <member name="P:NebSharp.Types.Alert.Status"> <summary> Status of the alert </summary> </member> <member name="P:NebSharp.Types.Alert.Summary"> <summary> A short summary of the alert </summary> </member> <member name="T:NebSharp.Types.AlertFilter"> <summary> A filter object to filter alerts. Allows filtering for specific alerts in nebulon ON. The filter allows multiple properties to be specified. If multiple properties are provided they are concatenated with a logical ``AND``. </summary> </member> <member name="P:NebSharp.Types.AlertFilter.CreatedAfter"> <summary> Filter for alerts created after the specified date and time </summary> </member> <member name="P:NebSharp.Types.AlertFilter.CreatedBefore"> <summary> Filter for alerts created before the specified date and time </summary> </member> <member name="P:NebSharp.Types.AlertFilter.ResourceID"> <summary> Filter for alerts that match the specified resource identifier </summary> </member> <member name="P:NebSharp.Types.AlertFilter.ResourceType"> <summary> Filter for alerts that match the specified resource type </summary> </member> <member name="P:NebSharp.Types.AlertFilter.Severity"> <summary> Filter for alerts that match the specified alert severity </summary> </member> <member name="P:NebSharp.Types.AlertFilter.Status"> <summary> Filter for alerts that match the specified status </summary> </member> <member name="T:NebSharp.Types.AlertList"> <summary> Paginated Alert list object Contains a list of alert objects and information for pagination. By default a single page includes a maximum of ``100`` items unless specified otherwise in the paginated query. Consumers should always check for the property ``more`` as per default the server does not return the full list of alerts but only one page. </summary> </member> <member name="T:NebSharp.Types.AuditStatus"> <summary> Defines the status of a record in the audit log </summary> </member> <member name="F:NebSharp.Types.AuditStatus.InProgress"> <summary> Operation is still ongoing </summary> </member> <member name="F:NebSharp.Types.AuditStatus.Completed"> <summary> Operation completed successfully </summary> </member> <member name="F:NebSharp.Types.AuditStatus.Failed"> <summary> Operation failed </summary> </member> <member name="T:NebSharp.Types.AuditLogEntry"> <summary> Instance of an audit record entry in nebulon ON. <para> An audit record entry represents an action that a user performed in nebulon ON. Actions include exclusively commands that alter the configuration of resources in nebulon ON or in your infrastructure. Queries that read configuration information are not included in the audit record list. </para> </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.ClientApp"> <summary> Client application identifier from which the operation was called </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.ClientIP"> <summary> IP address of the client that invoked the operation </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.ClientPlatform"> <summary> Client platform information from which the operation was called </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.Component"> <summary> Affected component by the operation </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.ComponentId"> <summary> Identifier of the affected component </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.Error"> <summary> Error message associated with the operation </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.Finish"> <summary> Completion date and time for the operation </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.NPodGuid"> <summary> Identifier of the nPod associated with the operation </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.NPodName"> <summary> Name of the nPod associated with the operation </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.Operation"> <summary> The operation a user executed </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.Parameters"> <summary> Parameters that were supplied with the operation as a JSON string </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.SpuSerial"> <summary> The SPU serial number that is associated with the operation </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.Start"> <summary> Start date and time for the operation </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.Status"> <summary> Status of the operation </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.UserGuid"> <summary> The identifier of the user that executed the operation </summary> </member> <member name="P:NebSharp.Types.AuditLogEntry.UserName"> <summary> The user name of the user that executed the operation </summary> </member> <member name="T:NebSharp.Types.AuditLogFilter"> <summary> A filter object to filter audit log entries Allows filtering for specific audit log entries in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <tt>and_filter</tt> and <tt>or_filter</tt> options to concatenate multiple filters. </summary> </member> <member name="P:NebSharp.Types.AuditLogFilter.Component"> <summary> Filter for records that match the specified component type </summary> </member> <member name="P:NebSharp.Types.AuditLogFilter.NPodGuid"> <summary> Filter for records that match the specified nPod UUID </summary> </member> <member name="P:NebSharp.Types.AuditLogFilter.Operation"> <summary> Filter for records that match the specified operation name </summary> </member> <member name="P:NebSharp.Types.AuditLogFilter.SpuSerial"> <summary> Filter for records that match the specified SPU serial number </summary> </member> <member name="P:NebSharp.Types.AuditLogFilter.StartAfter"> <summary> Filter for records created after the specified date and time </summary> </member> <member name="P:NebSharp.Types.AuditLogFilter.StartBefore"> <summary> Filter for records created before the specified date and time </summary> </member> <member name="P:NebSharp.Types.AuditLogFilter.Status"> <summary> Filter for records that match the specified operation status </summary> </member> <member name="T:NebSharp.Types.AuditLogList"> <summary> Paginated audit record list object. <para> Contains a list of audit records and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>more</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="P:NebSharp.Types.AuditLogList.Items"> <summary> List of audit log entries in the pagination list </summary> </member> <member name="P:NebSharp.Types.AuditLogList.More"> <summary> Indicates if there are more items on the server </summary> </member> <member name="T:NebSharp.Types.DateFormat"> <summary> Defines available date and time format options </summary> </member> <member name="F:NebSharp.Types.DateFormat.ANSIC"> <summary> Mon Jan _2 15:04:05 2006 </summary> </member> <member name="F:NebSharp.Types.DateFormat.UNIX_DATE"> <summary> Mon Jan _2 15:04:05 MST 2006 </summary> </member> <member name="F:NebSharp.Types.DateFormat.RUBY_DATE"> <summary> Mon Jan 02 15:04:05 -0700 2006 </summary> </member> <member name="F:NebSharp.Types.DateFormat.RFC822"> <summary> 02 Jan 06 15:04 MST </summary> </member> <member name="F:NebSharp.Types.DateFormat.RFC822_Z"> <summary> 02 Jan 06 15:04 -0700 </summary> </member> <member name="F:NebSharp.Types.DateFormat.RFC850"> <summary> Monday, 02-Jan-06 15:04:05 MST </summary> </member> <member name="F:NebSharp.Types.DateFormat.RFC1123"> <summary> Mon, 02 Jan 2006 15:04:05 MST </summary> </member> <member name="F:NebSharp.Types.DateFormat.RFC1123_Z"> <summary> Mon, 02 Jan 2006 15:04:05 -0700 </summary> </member> <member name="F:NebSharp.Types.DateFormat.RFC3339"> <summary> 2006-01-02T15:04:05Z07:00 </summary> </member> <member name="F:NebSharp.Types.DateFormat.RFC3339_NANO"> <summary> 2006-01-02T15:04:05.999999999Z07:00 </summary> </member> <member name="F:NebSharp.Types.DateFormat.KITCHEN"> <summary> 3:04PM </summary> </member> <member name="F:NebSharp.Types.DateFormat.STAMP"> <summary> Jan _2 15:04:05 </summary> </member> <member name="F:NebSharp.Types.DateFormat.STAMP_MILLI"> <summary> Jan _2 15:04:05.000 </summary> </member> <member name="F:NebSharp.Types.DateFormat.STAMP_MICRO"> <summary> Jan _2 15:04:05.000000 </summary> </member> <member name="F:NebSharp.Types.DateFormat.STAMP_NANO"> <summary> Jan _2 15:04:05.000000000 </summary> </member> <member name="T:NebSharp.Types.ResourceType"> <summary> Enumeration of available resource types in nebulon ON </summary> </member> <member name="F:NebSharp.Types.ResourceType.Unknown"> <summary> The resource type is not known </summary> </member> <member name="F:NebSharp.Types.ResourceType.Datacenter"> <summary> A datacenter location information resource </summary> </member> <member name="F:NebSharp.Types.ResourceType.Host"> <summary> A server or host resource </summary> </member> <member name="F:NebSharp.Types.ResourceType.Disk"> <summary> A physical drive or physical disk resource </summary> </member> <member name="F:NebSharp.Types.ResourceType.Pod"> <summary> A nPod resource </summary> </member> <member name="F:NebSharp.Types.ResourceType.PodGroup"> <summary> A group of nPods </summary> </member> <member name="F:NebSharp.Types.ResourceType.Lab"> <summary> A room or lab in a datacenter </summary> </member> <member name="F:NebSharp.Types.ResourceType.Rack"> <summary> A rack in a datacenter row </summary> </member> <member name="F:NebSharp.Types.ResourceType.Row"> <summary> A row in a datacenter </summary> </member> <member name="F:NebSharp.Types.ResourceType.Snapshot"> <summary> A point-in-time checkpoint of a storage volume </summary> </member> <member name="F:NebSharp.Types.ResourceType.SPU"> <summary> A services processing unit </summary> </member> <member name="F:NebSharp.Types.ResourceType.VM"> <summary> A virtual machine </summary> </member> <member name="F:NebSharp.Types.ResourceType.Volume"> <summary> A storage volume </summary> </member> <member name="F:NebSharp.Types.ResourceType.NetworkInterface"> <summary> A network interface </summary> </member> <member name="T:NebSharp.Types.SortDirection"> <summary> Defines sorting direction </summary> </member> <member name="F:NebSharp.Types.SortDirection.Ascending"> <summary> Sort items in ascending order </summary> </member> <member name="F:NebSharp.Types.SortDirection.Descending"> <summary> Sort items in descending order </summary> </member> <member name="T:NebSharp.Types.PageInput"> <summary> Defines input properties for pagination Allows specifying which page to return from the server for API calls that support pagination. It allows to specify the page number and the quantity of items to return in the page. Default values for a page are page number <c>1</c>, and <c>100</c> items per page. </summary> </member> <member name="M:NebSharp.Types.PageInput.#ctor(System.Int64,System.Int64)"> <summary> Constructs a new PageInput object. </summary> <param name="page"> The page number. Defaults to 1 </param> <param name="count"> The maximum number of items to include in a page. Defaults to 100 </param> <exception cref="T:System.ArgumentException"> Raised when provided values are out of range. </exception> </member> <member name="P:NebSharp.Types.PageInput.First"> <summary> The default first page </summary> </member> <member name="P:NebSharp.Types.PageInput.Count"> <summary> Specifies the number of items for each page. Defaults to <b>100</b>. </summary> </member> <member name="P:NebSharp.Types.PageInput.Page"> <summary> Specifies the page to return. Pages start at index <b>1</b>. </summary> </member> <member name="T:NebSharp.Types.PageList`1"> <summary> Base object for a paginated server response Contains a list of objects and information for pagination. By default a single page includes a maximum of `100` items unless specified otherwise in the paginated query. Consumers should always check for the property ``more`` as per default the server does not return the full list of alerts but only one page. </summary> </member> <member name="P:NebSharp.Types.PageList`1.FilteredCount"> <summary> The number of items on the server matching the provided filter </summary> </member> <member name="P:NebSharp.Types.PageList`1.Items"> <summary> List of items in the pagination list </summary> </member> <member name="P:NebSharp.Types.PageList`1.More"> <summary> Indicates if there are more items on the server </summary> </member> <member name="P:NebSharp.Types.PageList`1.TotalCount"> <summary> The total number of items on the server </summary> </member> <member name="T:NebSharp.Types.CommunicationMethodType"> <summary> Defines customer communication preferences </summary> </member> <member name="F:NebSharp.Types.CommunicationMethodType.Email"> <summary> Prefer communication via E-Mail </summary> </member> <member name="F:NebSharp.Types.CommunicationMethodType.Phone"> <summary> Prefer communication via Phone </summary> </member> <member name="T:NebSharp.Types.Address"> <summary> An address for a datacenter. <para> This information is used for support cases related to physical equipment in customer's datacenters and to allow part shipments to the provided address. </para> </summary> </member> <member name="P:NebSharp.Types.Address.Address1"> <summary> Address field 1, typically the street address </summary> </member> <member name="P:NebSharp.Types.Address.Address2"> <summary> Address field 2 </summary> </member> <member name="P:NebSharp.Types.Address.Address3"> <summary> Address field 3 </summary> </member> <member name="P:NebSharp.Types.Address.City"> <summary> City name for the address </summary> </member> <member name="P:NebSharp.Types.Address.CountryCode"> <summary> Country code for the address </summary> </member> <member name="P:NebSharp.Types.Address.HouseNumber"> <summary> House number and letters for the address </summary> </member> <member name="P:NebSharp.Types.Address.PostalCode"> <summary> Postal code for the address </summary> </member> <member name="P:NebSharp.Types.Address.StateProvinceCode"> <summary> State or province code for the address </summary> </member> <member name="T:NebSharp.Types.AddressInput"> <summary> An input object to setup an address for a datacenter. <para> Allows specifying a physical address for a datacenter. This information is used for support cases related to physical equipment in customer's datacenters and to allow part shipments to the provided address. </para> </summary> </member> <member name="P:NebSharp.Types.AddressInput.Address1"> <summary> Address field 1, typically the street address </summary> </member> <member name="P:NebSharp.Types.AddressInput.Address2"> <summary> Address field 2, if n/a provide an empty string </summary> </member> <member name="P:NebSharp.Types.AddressInput.Address3"> <summary> Address field 3, if n/a provide an empty string </summary> </member> <member name="P:NebSharp.Types.AddressInput.City"> <summary> City name for the address </summary> </member> <member name="P:NebSharp.Types.AddressInput.CountryCode"> <summary> Country code for the address </summary> </member> <member name="P:NebSharp.Types.AddressInput.HouseNumber"> <summary> House number and letters for the address </summary> </member> <member name="P:NebSharp.Types.AddressInput.PostalCode"> <summary> Postal code for the address </summary> </member> <member name="P:NebSharp.Types.AddressInput.StateProvinceCode"> <summary> State or province code for the address </summary> </member> <member name="T:NebSharp.Types.Contact"> <summary> Contact information for a datacenter. <para> This information is used to contact a customer in case of infrastructure issues and to send replacement parts. </para> </summary> </member> <member name="P:NebSharp.Types.Contact.BusinessPhone"> <summary> The business phone number of the contact </summary> </member> <member name="P:NebSharp.Types.Contact.CommunicationMethod"> <summary> Indicates the preferred communication method for this contact </summary> </member> <member name="P:NebSharp.Types.Contact.EmailAddress"> <summary> The email address of the contact </summary> </member> <member name="P:NebSharp.Types.Contact.FirstName"> <summary> The first name of the contact </summary> </member> <member name="P:NebSharp.Types.Contact.LastName"> <summary> The last name of the contact </summary> </member> <member name="P:NebSharp.Types.Contact.MobilePhone"> <summary> The mobile phone number of the contact </summary> </member> <member name="P:NebSharp.Types.Contact.Primary"> <summary> Indicates if this contact is the primary contact for a datacenter </summary> </member> <member name="P:NebSharp.Types.Contact.UserGuid"> <summary> The unique identifier of a nebulon ON user account </summary> </member> <member name="T:NebSharp.Types.ContactInput"> <summary> An input object to define a datacenter contact. <para> Allows specifying contact information for a data center.This information is used to contact a customer in case of infrastructure issues and to send replacement parts. </para> </summary> </member> <member name="P:NebSharp.Types.ContactInput.CommunicationMethod"> <summary> Indicates the preferred communication method for this contact </summary> </member> <member name="P:NebSharp.Types.ContactInput.Primary"> <summary> Indicates if this contact is the primary contact for a datacenter </summary> </member> <member name="P:NebSharp.Types.ContactInput.UserGuid"> <summary> The unique identifier of a nebulon ON user account </summary> </member> <member name="T:NebSharp.Types.CreateDataCenterInput"> <summary> An input object to create a datacenter. <para> Allows the creation of a datacenter object in nebulon ON. A datacenter record allows customers to logically organize their infrastructure by physical location and associate address and contact information with the physical location. This is useful for effective support case handling and reporting purposes. </para> </summary> </member> <member name="P:NebSharp.Types.CreateDataCenterInput.Address"> <summary> Postal address for the datacenter </summary> </member> <member name="P:NebSharp.Types.CreateDataCenterInput.Contacts"> <summary> List of contacts for the new datacenter. At least one contact must be provided.Exactly one contact must be marked as primary. </summary> </member> <member name="P:NebSharp.Types.CreateDataCenterInput.Name"> <summary> Name of the datacenter </summary> </member> <member name="P:NebSharp.Types.CreateDataCenterInput.Note"> <summary> An optional note for the datacenter </summary> </member> <member name="T:NebSharp.Types.DataCenter"> <summary> A datacenter object. <para> A datacenter record allows customers to logically organize their infrastructure by physical location and associate address and contact information with the physical location. This is useful for effective support case handling and reporting purposes. </para> </summary> </member> <member name="P:NebSharp.Types.DataCenter.Address"> <summary> Postal address for the datacenter </summary> </member> <member name="P:NebSharp.Types.DataCenter.Contacts"> <summary> List of contacts for the datacenter </summary> </member> <member name="P:NebSharp.Types.DataCenter.Guid"> <summary> Unique identifier of the datacenter </summary> </member> <member name="P:NebSharp.Types.DataCenter.HostCount"> <summary> Number of hosts in the datacenter </summary> </member> <member name="P:NebSharp.Types.DataCenter.Name"> <summary> Name for the datacenter </summary> </member> <member name="P:NebSharp.Types.DataCenter.Note"> <summary> An optional note for the datacenter </summary> </member> <member name="P:NebSharp.Types.DataCenter.RackCount"> <summary> Number of racks in the datacenter </summary> </member> <member name="P:NebSharp.Types.DataCenter.RoomCount"> <summary> Number of rooms in the datacenter </summary> </member> <member name="P:NebSharp.Types.DataCenter.RoomGuids"> <summary> Unique identifiers of rooms in the datacenter </summary> </member> <member name="P:NebSharp.Types.DataCenter.RowCount"> <summary> Number of rows in the datacenter </summary> </member> <member name="T:NebSharp.Types.DataCenterFilter"> <summary> A filter object to filter datacenters. <para> Allows filtering for specific datacenters in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>and_filter</c> and <c>or_filter</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.DataCenterFilter.And"> <summary> Allows concatenation of multiple filters via logical <c>AND</c>. </summary> </member> <member name="P:NebSharp.Types.DataCenterFilter.DataCenterGuid"> <summary> Filter based on datacenter unique identifier </summary> </member> <member name="P:NebSharp.Types.DataCenterFilter.Name"> <summary> Filter based on datacenter name </summary> </member> <member name="P:NebSharp.Types.DataCenterFilter.Or"> <summary> Allows concatenation of multiple filters via logical <c>OR</c>. </summary> </member> <member name="T:NebSharp.Types.DataCenterList"> <summary> Paginated datacenter list object. <para> Contains a list of datacenter objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>more</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.DataCenterSort"> <summary> A sort object for datacenters. <para>Allows sorting datacenters on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.DataCenterSort.Name"> <summary> Sort direction for the <c>name</c> property </summary> </member> <member name="T:NebSharp.Types.DeleteDataCenterInput"> <summary> An input object to delete a datacenter object. <para> Allows additional options when deleting a datacenter. When <c>cascade</c> is set to <c>true</c> all child resources are deleted with the datacenter if no hosts are associated with the datacenter. </para> </summary> </member> <member name="P:NebSharp.Types.DeleteDataCenterInput.Cascade"> <summary> If set to <c>true</c> any child resources are deleted with the datacenter if no hosts are associated with them. </summary> </member> <member name="T:NebSharp.Types.UpdateDataCenterInput"> <summary> An input object to update datacenter properties. <para> Allows updating of an existing datacenter object in nebulon ON. A datacenter record allows customers to logically organize their infrastructure by physical location and associate address and contact information with the physical location. This is useful for effective support case handling and reporting purposes. </para> </summary> </member> <member name="P:NebSharp.Types.UpdateDataCenterInput.Address"> <summary> New postal address for the datacenter </summary> </member> <member name="P:NebSharp.Types.UpdateDataCenterInput.Contacts"> <summary> New list of contacts for the datacenter. If provided, the list of contacts must have at least one contact. Exactly one contact must be marked as primary. </summary> </member> <member name="P:NebSharp.Types.UpdateDataCenterInput.Name"> <summary> New name for the datacenter </summary> </member> <member name="P:NebSharp.Types.UpdateDataCenterInput.Note"> <summary> The new note for the datacenter. For removing the note, provide an empty str. </summary> </member> <member name="T:NebSharp.Types.GuidFilter"> <summary> A filter object to filter on Guid values <para> Allows filtering on <c>Guid</c> value types. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.GuidFilter.And"> <summary> Allows concatenation with another GuidFilter with a logical <c>AND</c> </summary> </member> <member name="P:NebSharp.Types.GuidFilter.In"> <summary> Matches if a Guid is on of a provided list of values </summary> </member> <member name="P:NebSharp.Types.GuidFilter.MustEqual"> <summary> Filters Guids by being an exact match </summary> </member> <member name="P:NebSharp.Types.GuidFilter.MustNotEqual"> <summary> Filters Guids by not being an exact match </summary> </member> <member name="P:NebSharp.Types.GuidFilter.Or"> <summary> Allows concatenation with another GuidFilter with a logical <c>OR</c> </summary> </member> <member name="T:NebSharp.Types.IntFilter"> <summary> Defines filtering options for the Integer type. <para> Allows filtering on <c>Integer</c> value types. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.IntFilter.And"> <summary> Allows concatenation with another int filer with a logical <c>AND</c> </summary> </member> <member name="P:NebSharp.Types.IntFilter.GreaterThan"> <summary> Filters values with a <c>></c> comparison </summary> </member> <member name="P:NebSharp.Types.IntFilter.GreaterThanEquals"> <summary> Filters values with a <c>≥</c> comparison </summary> </member> <member name="P:NebSharp.Types.IntFilter.In"> <summary> Matches if an Integer is on of a provided list of values </summary> </member> <member name="P:NebSharp.Types.IntFilter.LessThan"> <summary> Filters values with a <c><</c> comparison </summary> </member> <member name="P:NebSharp.Types.IntFilter.LessThanEquals"> <summary> Filters values with a <c>≤</c> comparison </summary> </member> <member name="P:NebSharp.Types.IntFilter.MustEqual"> <summary> Filters values with a <c>==</c> comparison </summary> </member> <member name="P:NebSharp.Types.IntFilter.MustNotEqual"> <summary> Filters values with a <c>!=</c> comparison </summary> </member> <member name="P:NebSharp.Types.IntFilter.Or"> <summary> Allows concatenation with another int filer with a logical <c>OR</c> </summary> </member> <member name="T:NebSharp.Types.StringFilter"> <summary> A filter object to filter items based on String values <para> Allows filtering on <c>str</c> value types. The filter allows only one property to be specified.If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.StringFilter.And"> <summary> Allows concatenation with another string filer with a logical <c>AND</c> </summary> </member> <member name="P:NebSharp.Types.StringFilter.BeginsWith"> <summary> Matches if a string begins with a provided value </summary> </member> <member name="P:NebSharp.Types.StringFilter.Contains"> <summary> Matches if a string contains a provided value </summary> </member> <member name="P:NebSharp.Types.StringFilter.EndsWith"> <summary> Matches if a string ends with a provided value </summary> </member> <member name="P:NebSharp.Types.StringFilter.In"> <summary> Matches if a string is on of a provided list of values </summary> </member> <member name="P:NebSharp.Types.StringFilter.MustEqual"> <summary> Filters strings by an exact match </summary> </member> <member name="P:NebSharp.Types.StringFilter.MustNotEqual"> <summary> "Filters strings by not being an exact match </summary> </member> <member name="P:NebSharp.Types.StringFilter.NotContains"> <summary> Matches if a string does not contain a provided value </summary> </member> <member name="P:NebSharp.Types.StringFilter.Or"> <summary> Allows concatenation with another string filer with a logical <c>OR</c> </summary> </member> <member name="P:NebSharp.Types.StringFilter.Regex"> <summary> Matches by use of a regular expression </summary> </member> <member name="T:NebSharp.Types.Dimm"> <summary> A memory DIMM object </summary> </member> <member name="P:NebSharp.Types.Dimm.Location"> <summary> Location of the DIMM in the server </summary> </member> <member name="P:NebSharp.Types.Dimm.Manufacturer"> <summary> Location of the DIMM in the server </summary> </member> <member name="P:NebSharp.Types.Dimm.SizeBytes"> <summary> Location of the DIMM in the server </summary> </member> <member name="T:NebSharp.Types.Host"> <summary> A host or server that contains a nebulon SPU </summary> </member> <member name="P:NebSharp.Types.Host.BoardSerial"> <summary> Board serial number of the host </summary> </member> <member name="P:NebSharp.Types.Host.BootTime"> <summary> Date and time when the host booted </summary> </member> <member name="P:NebSharp.Types.Host.ChassisSerial"> <summary> Chassis serial number of the host </summary> </member> <member name="P:NebSharp.Types.Host.CpuCoreCount"> <summary> Number of cores of the installed CPUs </summary> </member> <member name="P:NebSharp.Types.Host.CpuCount"> <summary> Number of installed CPUs in this host </summary> </member> <member name="P:NebSharp.Types.Host.CpuManufacturer"> <summary> CPU manufacturer of the CPUs installed in this host </summary> </member> <member name="P:NebSharp.Types.Host.CpuSpeed"> <summary> CPU clock speed </summary> </member> <member name="P:NebSharp.Types.Host.CpuThreadCount"> <summary> Number of threads of the installed CPUs </summary> </member> <member name="P:NebSharp.Types.Host.CpuType"> <summary> CPU type of the CPUs installed in this host </summary> </member> <member name="P:NebSharp.Types.Host.DimmCount"> <summary> CPU clock speed </summary> </member> <member name="P:NebSharp.Types.Host.Dimms"> <summary> List of DIMMs installed in this host </summary> </member> <member name="P:NebSharp.Types.Host.Guid"> <summary> Unique identifier of the host </summary> </member> <member name="P:NebSharp.Types.Host.LomAddress"> <summary> IP address of the lights out management address of the host </summary> </member> <member name="P:NebSharp.Types.Host.LomHostname"> <summary> Hostname of the lights out management address of the host </summary> </member> <member name="P:NebSharp.Types.Host.Manufacturer"> <summary> Manufacturer name for this host </summary> </member> <member name="P:NebSharp.Types.Host.MemoryBytes"> <summary> Total amount of memory in bytes </summary> </member> <member name="P:NebSharp.Types.Host.Model"> <summary> Model of the host </summary> </member> <member name="P:NebSharp.Types.Host.Name"> <summary> Name of the host </summary> </member> <member name="P:NebSharp.Types.Host.Note"> <summary> Optional note for the host </summary> </member> <member name="P:NebSharp.Types.Host.NPodGuid"> <summary> The unique identifier of the nPod this host is part of </summary> </member> <member name="P:NebSharp.Types.Host.RackGuid"> <summary> Unique identifier associated with this host </summary> </member> <member name="P:NebSharp.Types.Host.SpuCount"> <summary> Number of SPUs installed in this host </summary> </member> <member name="P:NebSharp.Types.Host.SpuSerials"> <summary> List of SPU serial numbers that are installed in this host </summary> </member> <member name="T:NebSharp.Types.HostFilter"> <summary> A filter object to filter hosts. <para> Allows filtering for specific hosts in nebulon ON.The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.HostFilter.And"> <summary> Allows concatenation of multiple filters via logical <c>AND</c> </summary> </member> <member name="P:NebSharp.Types.HostFilter.BoardSerial"> <summary> Filter based on board serial number </summary> </member> <member name="P:NebSharp.Types.HostFilter.ChassisSerial"> <summary> Filter based on host chassis serial number </summary> </member> <member name="P:NebSharp.Types.HostFilter.HostGuid"> <summary> Filter based on host unique identifier </summary> </member> <member name="P:NebSharp.Types.HostFilter.Manufacturer"> <summary> Filter based on host manufacturer name </summary> </member> <member name="P:NebSharp.Types.HostFilter.Model"> <summary> Filter based on host model name </summary> </member> <member name="P:NebSharp.Types.HostFilter.Name"> <summary> Filter based on host name </summary> </member> <member name="P:NebSharp.Types.HostFilter.NPodGuid"> <summary> Filter based on nPod unique identifier </summary> </member> <member name="P:NebSharp.Types.HostFilter.Or"> <summary> Allows concatenation of multiple filters via logical <c>OR</c> </summary> </member> <member name="T:NebSharp.Types.HostList"> <summary> Paginated host list object <para> Contains a list of host objects and information for pagination.By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>more</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.HostSort"> <summary> A sort object for hosts <para> Allows sorting hosts on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.HostSort.Manufacturer"> <summary> Sort direction for the <c>Manufacturer</c> property of a host object </summary> </member> <member name="P:NebSharp.Types.HostSort.Model"> <summary> Sort direction for the <c>Model</c> property of a host object </summary> </member> <member name="P:NebSharp.Types.HostSort.Name"> <summary> Sort direction for the <c>Name</c> property of a host object </summary> </member> <member name="T:NebSharp.Types.UpdateHostInput"> <summary> An input object to update host properties. <para> Allows updating of an existing host object in nebulon ON. Only few properties of a host are user modifiable. Most properties are automatically populated by the host's services processing unit (SPU). </para> </summary> </member> <member name="P:NebSharp.Types.UpdateHostInput.Name"> <summary> Name of the host (server) </summary> </member> <member name="P:NebSharp.Types.UpdateHostInput.Note"> <summary> Optional note for the host </summary> </member> <member name="P:NebSharp.Types.UpdateHostInput.RackGuid"> <summary> Associated unique identifier of a rack associated with the host </summary> </member> <member name="T:NebSharp.Types.IssueInstance"> <summary> An issue instance <para> Issue instances describe issues with certain nebulon ON commands as part of a pre-execution step.Issues can be of type warning or errors. Warnings may be ignored (although not recommended), whereas errors are blocking users from continuing with the main execution. </para> </summary> </member> <member name="P:NebSharp.Types.IssueInstance.Message"> <summary> Error or warning message of the issue instance </summary> </member> <member name="P:NebSharp.Types.IssueInstance.SpuSerials"> <summary> List of SPU serial numbers associated with the issue instance </summary> </member> <member name="T:NebSharp.Types.Issues"> <summary> List of issue instances <para> Issues describe issues with certain nebulon ON commands as part of a pre-execution step.Issues can be of type warning or errors. Warnings may be ignored (although not recommended), whereas errors are blocking users from continuing with the main execution. </para> </summary> </member> <member name="P:NebSharp.Types.Issues.Errors"> <summary> List or errors. Errors need to be resolved before continuing </summary> </member> <member name="P:NebSharp.Types.Issues.Warnings"> <summary> List of warnings. Warnings can be ignored although not recommended </summary> </member> <member name="M:NebSharp.Types.Issues.AssertNoIssues(System.Boolean)"> <summary> Utility method to check for issues <para> Method checks if there are any warnings or errors present in the list of issues. If there are any issues of type error, an exception is raised. If there are any warnings and <c>ignoreWarnings</c> is set to <c>false</c> an exception is thrown, if set to <c>true</c>, warnings are ignored. </para> </summary> <param name="ignoreWarnings"> If set to <c>true</c> warnings are silently ignored. By default warnings are not ignored </param> </member> <member name="T:NebSharp.Types.DeleteKeyValueInput"> <summary> An input object to delete a key value entry </summary> </member> <member name="P:NebSharp.Types.DeleteKeyValueInput.Key"> <summary> Metadata key </summary> </member> <member name="P:NebSharp.Types.DeleteKeyValueInput.NPodGroupGuid"> <summary> "nPod Group identifier </summary> </member> <member name="P:NebSharp.Types.DeleteKeyValueInput.ResourceId"> <summary> Identifier of the resource for the key value entry </summary> </member> <member name="P:NebSharp.Types.DeleteKeyValueInput.ResourceType"> <summary> Type of resource for the key value data </summary> </member> <member name="T:NebSharp.Types.KeyValue"> <summary> Key value pair <para> Represents metadata assigned to various resources in nebulon ON in the form of key value pairs.This metadata can be used by customers to add arbitrary text information to resources that are not part of the default resource properties. </para> </summary> </member> <member name="P:NebSharp.Types.KeyValue.Key"> <summary> Metadata key </summary> </member> <member name="P:NebSharp.Types.KeyValue.Value"> <summary> Metadata value </summary> </member> <member name="T:NebSharp.Types.KeyValueFilter"> <summary> A filter object to filter key value objects. <para> Allows filtering for specific key value objects in nebulon ON.The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.KeyValueFilter.KeyName"> <summary> Filter based on the key name </summary> </member> <member name="P:NebSharp.Types.KeyValueFilter.NPodGroupGuid"> <summary> Filter based on the associated nPod group </summary> </member> <member name="P:NebSharp.Types.KeyValueFilter.ResourceId"> <summary> Filter based on the associated Resource </summary> </member> <member name="P:NebSharp.Types.KeyValueFilter.ResourceType"> <summary> Filter based on the associated resource type </summary> </member> <member name="T:NebSharp.Types.KeyValueList"> <summary> List of key value pairs </summary> </member> <member name="P:NebSharp.Types.KeyValueList.FilteredCount"> <summary> Indicates the total amount of items defined on the server that match a filter input object. </summary> </member> <member name="P:NebSharp.Types.KeyValueList.Items"> <summary> Contains the items returned in the page </summary> </member> <member name="P:NebSharp.Types.KeyValueList.TotalCount"> <summary> Indicates the total amount of items defined on the server </summary> </member> <member name="T:NebSharp.Types.UpsertKeyValueInput"> <summary> An input object to create or update a key value entry. <para> Allows adding metadata to various resources in nebulon ON in the form of key value pairs. This metadata can be used by customers to add arbitrary text information to resources that are not part of the default resource properties. </para> </summary> </member> <member name="P:NebSharp.Types.UpsertKeyValueInput.Key"> <summary> Metadata key </summary> </member> <member name="P:NebSharp.Types.UpsertKeyValueInput.NPodGroupId"> <summary> nPod Group identifier </summary> </member> <member name="P:NebSharp.Types.UpsertKeyValueInput.ResourceId"> <summary> "Identifier of the resource for the key value entry </summary> </member> <member name="P:NebSharp.Types.UpsertKeyValueInput.ResourceType"> <summary> Type of resource for the key value data </summary> </member> <member name="P:NebSharp.Types.UpsertKeyValueInput.Value"> <summary> Metadata value </summary> </member> <member name="T:NebSharp.Types.BatchDeleteLunInput"> <summary> An input object to delete multiple LUNs at once </summary> </member> <member name="P:NebSharp.Types.BatchDeleteLunInput.HostGuids"> <summary> List of host identifiers from which LUNs shall be deleted </summary> </member> <member name="P:NebSharp.Types.BatchDeleteLunInput.LunGuids"> <summary> List of LUN identifiers that shall be deleted </summary> </member> <member name="P:NebSharp.Types.BatchDeleteLunInput.VolumeGuid"> <summary> Identifier of the volume from which LUNs shall be deleted </summary> </member> <member name="T:NebSharp.Types.CreateLunInput"> <summary> An input object to create a LUN for a volume <para> Allows the creation of a LUN for a volume.A LUN is an instance of a volume export that makes a volume accessible to a host. </para> </summary> </member> <member name="P:NebSharp.Types.CreateLunInput.HostGuids"> <summary> List of host UUIDs that identify the hosts the volume shall be exported to. This must be provided if <c>SpuSerials</c> is not provided. </summary> </member> <member name="P:NebSharp.Types.CreateLunInput.Local"> <summary> If <c>true</c>, volumes will be exported with ALUA turned off </summary> </member> <member name="P:NebSharp.Types.CreateLunInput.LunId"> <summary> An optional LUN ID to assign to the volume export </summary> </member> <member name="P:NebSharp.Types.CreateLunInput.SpuSerials"> <summary> List of serial numbers of the SPUs from which a volume shall be exported from </summary> </member> <member name="P:NebSharp.Types.CreateLunInput.VolumeGuid"> <summary> The unique identifier of the volume that shall be made available to a host </summary> </member> <member name="T:NebSharp.Types.Lun"> <summary> A LUN / an export of a volume to a host <para> A LUN is an instance of a volume export that makes a volume accessible to a host </para> </summary> </member> <member name="P:NebSharp.Types.Lun.Guid"> <summary> The unique identifier of the LUN </summary> </member> <member name="P:NebSharp.Types.Lun.HostGuid"> <summary> The unique identifier of the host this volume is exported to </summary> </member> <member name="P:NebSharp.Types.Lun.LunId"> <summary> The LUN ID of the volume export </summary> </member> <member name="P:NebSharp.Types.Lun.SpuSerial"> <summary> The SPU serial where the LUN is exported from </summary> </member> <member name="P:NebSharp.Types.Lun.VolumeGuid"> <summary> The unique identifier of the volume that is exported </summary> </member> <member name="T:NebSharp.Types.LunFilter"> <summary> A filter object to filter LUNs. <para> Allows filtering for specific LUNs.The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.LunFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.LunFilter.HostGuid"> <summary> Filter based on host unique identifer </summary> </member> <member name="P:NebSharp.Types.LunFilter.LunGuid"> <summary> Filter based on LUN unique identifier </summary> </member> <member name="P:NebSharp.Types.LunFilter.LunId"> <summary> Filter based on LUN ID </summary> </member> <member name="P:NebSharp.Types.LunFilter.NPodGuid"> <summary> Filter based on nPod unique identifier </summary> </member> <member name="P:NebSharp.Types.LunFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="P:NebSharp.Types.LunFilter.SpuSerial"> <summary> Filter based on SPU serial number </summary> </member> <member name="P:NebSharp.Types.LunFilter.VolumeGuid"> <summary> Filter based on volume unique identifier </summary> </member> <member name="T:NebSharp.Types.LunList"> <summary> Pagination list definition for LUN query </summary> </member> <member name="T:NebSharp.Types.LunSort"> <summary> A sort object for LUNs <para> Allows sorting LUNs on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.LunSort.LunId"> <summary> Sort direction for the <c>LunId</c> property of a Lun </summary> </member> <member name="T:NebSharp.Types.Metadata"> <summary> Metadata information that describes UCAPI </summary> </member> <member name="P:NebSharp.Types.Metadata.RBAC"> <summary> Metadata information for role-based access control </summary> </member> <member name="P:NebSharp.Types.Metadata.SupportMetadata"> <summary> Metadata information for support </summary> </member> <member name="T:NebSharp.Types.MetaValue"> <summary> Metadata information that describes API options </summary> </member> <member name="P:NebSharp.Types.MetaValue.Actual"> <summary> Actual value </summary> </member> <member name="P:NebSharp.Types.MetaValue.Description"> <summary> Description of the value </summary> </member> <member name="T:NebSharp.Types.RBACMetadata"> <summary> Metadata information for role-based access control </summary> </member> <member name="P:NebSharp.Types.RBACMetadata.Permissions"> <summary> List possible permissions </summary> </member> <member name="P:NebSharp.Types.RBACMetadata.ResourceTypes"> <summary> List of possible resource types </summary> </member> <member name="T:NebSharp.Types.SupportMetadata"> <summary> Metadata information for Support options </summary> </member> <member name="P:NebSharp.Types.SupportMetadata.ResourceTypes"> <summary> List of possible resource types </summary> </member> <member name="T:NebSharp.Types.CreateNPodGroupInput"> <summary> An input object to create a new nPod group <para> Allows creation of a new nPod group object in nebulon ON. A nPod group allows logical grouping of nPods into security domains. Each nPod group can receive custom security policies. </para> </summary> </member> <member name="P:NebSharp.Types.CreateNPodGroupInput.Name"> <summary> The name of the nPod group </summary> </member> <member name="P:NebSharp.Types.CreateNPodGroupInput.Note"> <summary> The note for the nPod group </summary> </member> <member name="T:NebSharp.Types.NPodGroup"> <summary> A group of nPods <para> A nPod group allows logical grouping of nPods into security domains. Each nPod group can receive custom security policies and contain multiple nPods. </para> </summary> </member> <member name="P:NebSharp.Types.NPodGroup.Guid"> <summary> The unique identifier for the nPod group </summary> </member> <member name="P:NebSharp.Types.NPodGroup.HostCount"> <summary> Number of hosts (servers) in this nPod group </summary> </member> <member name="P:NebSharp.Types.NPodGroup.Name"> <summary> The name of the nPod group </summary> </member> <member name="P:NebSharp.Types.NPodGroup.Note"> <summary> An optional note for the nPod group </summary> </member> <member name="P:NebSharp.Types.NPodGroup.NPodCount"> <summary> Number of nPods in this nPod group </summary> </member> <member name="P:NebSharp.Types.NPodGroup.NPodGuids"> <summary> List of nPod unique identifiers in this nPod group </summary> </member> <member name="P:NebSharp.Types.NPodGroup.SpuCount"> <summary> Number of services processing units in this nPod group </summary> </member> <member name="T:NebSharp.Types.NPodGroupFilter"> <summary> A filter object to filter nPod groups. <para> Allows filtering for specific nPod groups in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.NPodGroupFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.NPodGroupFilter.Guid"> <summary> Filter based on nPod group unique identifier </summary> </member> <member name="P:NebSharp.Types.NPodGroupFilter.Name"> <summary> Filter based on nPod group name </summary> </member> <member name="P:NebSharp.Types.NPodGroupFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="T:NebSharp.Types.NPodGroupList"> <summary> Paginated nPod group list object <para> Contains a list of nPod group objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.NPodGroupSort"> <summary> A sort object for nPod groups <para> Allows sorting nPod groups on common properties. The sort object allows only one property to be specified </para> </summary> </member> <member name="P:NebSharp.Types.NPodGroupSort.Name"> <summary> Sort direction for <c>Name</c> property </summary> </member> <member name="T:NebSharp.Types.UpdateNPodGroupInput"> <summary> An input object to update nPod group properties <para> Allows updating of an existing nPod group object in nebulon ON. A nPod group allows logical grouping of nPods into security domains. Each nPod group can receive custom security policies. </para> </summary> </member> <member name="P:NebSharp.Types.UpdateNPodGroupInput.Name"> <summary> The new name of the nPod group </summary> </member> <member name="P:NebSharp.Types.UpdateNPodGroupInput.Note"> <summary> The new note for the nPod group </summary> </member> <member name="T:NebSharp.Types.BondLACPTransmitRate"> <summary> Link aggregation transmit rate for LCAP </summary> </member> <member name="F:NebSharp.Types.BondLACPTransmitRate.LACPTransmitRateSlow"> <summary> Transmit rate slow </summary> </member> <member name="F:NebSharp.Types.BondLACPTransmitRate.LACPTransmitRateFast"> <summary> Transmit rate fast </summary> </member> <member name="T:NebSharp.Types.BondTransmitHashPolicy"> <summary> Transmit has policy used by link aggregation </summary> </member> <member name="F:NebSharp.Types.BondTransmitHashPolicy.TransmitHashPolicyLayer2"> <summary> Hash policy layer 2 </summary> </member> <member name="F:NebSharp.Types.BondTransmitHashPolicy.TransmitHashPolicyLayer34"> <summary> Hash policy layer 3 and 4 </summary> </member> <member name="F:NebSharp.Types.BondTransmitHashPolicy.TransmitHashPolicyLayer23"> <summary> Hash policy layer 2 and 3 </summary> </member> <member name="T:NebSharp.Types.BondType"> <summary> Link aggregation type for data ports </summary> </member> <member name="F:NebSharp.Types.BondType.BondModeNone"> <summary> No link aggregation is used </summary> </member> <member name="F:NebSharp.Types.BondType.BondMode8023ad"> <summary> Link aggregation IEEE 802.3ad </summary> </member> <member name="F:NebSharp.Types.BondType.BondModeBalanceALB"> <summary> Link aggregation Balance ALB </summary> </member> <member name="T:NebSharp.Types.CreateNPodInput"> <summary> An input object to create a new nPod <para> A nPod is a collection of network-connected application servers with SPUs installed that form an application cluster.Together, the SPUs in a nPod serve shared or local storage to the servers in the application cluster, e.g.a hypervisor cluster, container platform, or clustered bare metal application. </para> </summary> </member> <member name="P:NebSharp.Types.CreateNPodInput.Name"> <summary> Name of the new nPod </summary> </member> <member name="P:NebSharp.Types.CreateNPodInput.Note"> <summary> An optional note for the new nPod </summary> </member> <member name="P:NebSharp.Types.CreateNPodInput.NPodGroupGuid"> <summary> The unique identifier of the nPod group this nPod will be added to </summary> </member> <member name="P:NebSharp.Types.CreateNPodInput.NPodTemplateGuid"> <summary> The unique identifier of the nPod template to use for the new nPod. </summary> </member> <member name="P:NebSharp.Types.CreateNPodInput.Spus"> <summary> List of SPU configuration information that will be used in the new nPod. </summary> </member> <member name="P:NebSharp.Types.CreateNPodInput.Timezone"> <summary> The timezone to be configured for all SPUs in the nPod </summary> </member> <member name="T:NebSharp.Types.ExpectedNPodCapacity"> <summary> Describes information for nPods that are about to be created <para> Allows predicting of the storage configuration of an nPod before its creation. </para> </summary> </member> <member name="P:NebSharp.Types.ExpectedNPodCapacity.TemplateSavingFactor"> <summary> Savings factor used for the calculation, provided by the template </summary> </member> <member name="P:NebSharp.Types.ExpectedNPodCapacity.TotalPhysicalDiskCapacityBlocks"> <summary> Total physical drive capacity in blocks (512 bytes) </summary> </member> <member name="P:NebSharp.Types.ExpectedNPodCapacity.TotalPresentedCapacity"> <summary> Total capacity presented to hosts </summary> </member> <member name="P:NebSharp.Types.ExpectedNPodCapacity.TotalRawCapacityBlocks"> <summary> Total raw capacity in blocks (512 bytes) </summary> </member> <member name="P:NebSharp.Types.ExpectedNPodCapacity.TotalUserDataCapacityBlocks"> <summary> Total usable capacity in blocks (512 bytes) </summary> </member> <member name="P:NebSharp.Types.ExpectedNPodCapacity.TotalVolumeCount"> <summary> Total number of volumes that will be created </summary> </member> <member name="T:NebSharp.Types.IPInfoConfigInput"> <summary> An input object to configure SPU networking <para> SPU network configuration is determined at nPod creation. Customers have the option to use static IP addresses for the control network or DHCP. When using DHCP, it is recommended to use static IP reservations for the data networks. </para> <para> Customers can choose between using two separate networks for the data network or a link aggregation (LACP). When using link aggregation, two interface names are expected, one if not. </para> <para> When specifying an IP address, it can be either IPv4 or IPv6 and supports the CIDR address format. </para> </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.Address"> <summary> The IPv4 or IPv6 address for the data network interface. If CIDR format is used, the <c>NetmaskBits</c> value is ignored. If <c>Dhcp</c> is set to <c>true</c>, this field must not be specified. </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.BondLACPTransmitRate"> <summary> Allows altering the default LACP transmit rate. This field is ignored if <c>BondMode</c> is not set to <c>BondMode8023ad</c>. </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.BondMIIMonitorMilliSeconds"> <summary> Allows alerting the default media independent interface monitoring interval. This field is ignored when <c>BondMonde</c> is set to <c>None</c>. </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.BondMode"> <summary> Specifies the link aggregation mode for the data network ports. If not set to <c>None</c>, the <c>Interfaces</c> parameter must be an array that lists the names of both interfaces: <c>["enP8p1s0f0np0", "enP8p1s0f1np1"]</c>, if set to <c>None</c> the specific interface must be identified by its name. </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.BondTransmitHashPolicy"> <summary> Allows specifying the transmit hashing policy mode when using link aggregation.This field is ignored when <c>BondMonde</c> is set to <c>None</c>. </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.Dhcp"> <summary> Specifies if DHCP should be used for the data network. If set to <c>true</c>, fields <c>Address</c>, <c>NetMaskBits</c>, <c>Gateway</c> are optional. If set to <c>false</c>, these values become mandatory. </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.Gateway"> <summary> The network gateway address for the network interface. If <c>Dhcp</c> is set to <c>true</c> this field is optional and ignored. If static IP address is used, this field is mandatory. </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.HalfDuplex"> <summary> Specifies if the network interface shall use half duplex. By default, this field should be set to <c>false</c>. </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.Interfaces"> <summary> List of interfaces that shall be configured with this object. If <c>BondMone</c> is set to <c>None</c> a single interface shall be specified. If set to a link aggregation mode both data interface names shall be specified. Options are "enP8p1s0f0np0" and "enP8p1s0f1np1". </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.LockedSpeed"> <summary> Allows setting the interface speed and the duplex mode to specific values. If set to <c>true</c> the values of <c>SpeedMB</c> and <c>HalfDuplex</c> are enforced. </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.Mtu"> <summary> Allows setting the maximum transfer unit (MTU) for the interface. By default an MTU of <c>1500</c> is used. </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.NetmaskBits"> <summary> The network mask in bits. If <c>Address</c> is specified in CIDR format, this value will be ignored, otherwise this is a mandatory field. </summary> </member> <member name="P:NebSharp.Types.IPInfoConfigInput.SpeedMB"> <summary> Allows setting the interface speed to a specific value. This field is ignored when <c>LockedSpeed</c> is set to <c>false</c> (default). </summary> </member> <member name="T:NebSharp.Types.NebNpodSort"> <summary> A sort object for nPods <para> Allows sorting nPods on common properties.The sort object allows only one property to be specified </para> </summary> </member> <member name="P:NebSharp.Types.NebNpodSort.Name"> <summary> Sort direction for <c>Name</c> property </summary> </member> <member name="T:NebSharp.Types.NPod"> <summary> Defines a nebulon Pod (nPod) <para> A nPod is a collection of network-connected application servers with SPUs installed that form an application cluster. Together, the SPUs in a nPod serve shared or local storage to the servers in the application cluster, e.g.a hypervisor cluster, container platform, or clustered bare metal application. </para> </summary> </member> <member name="P:NebSharp.Types.NPod.Guid"> <summary> The unique identifier of the nPod </summary> </member> <member name="P:NebSharp.Types.NPod.HostCount"> <summary> Number of hosts / servers part of this nPod </summary> </member> <member name="P:NebSharp.Types.NPod.HostGuids"> <summary> List of host identifiers part of this nPod </summary> </member> <member name="P:NebSharp.Types.NPod.Name"> <summary> The name of the nPod </summary> </member> <member name="P:NebSharp.Types.NPod.Note"> <summary> An optional note for the nPod </summary> </member> <member name="P:NebSharp.Types.NPod.NPodGroupGuid"> <summary> The unique identifier of the nPod group this nPod belongs to </summary> </member> <member name="P:NebSharp.Types.NPod.SnapshotGuids"> <summary> List of snapshot identifiers defined in this nPod </summary> </member> <member name="P:NebSharp.Types.NPod.SpuCount"> <summary> Number of spus part of this nPod </summary> </member> <member name="P:NebSharp.Types.NPod.SpuSerials"> <summary> List of serial numbers part of this nPod </summary> </member> <member name="P:NebSharp.Types.NPod.UpdateHistory"> <summary> List of updates performed on this nPod </summary> </member> <member name="P:NebSharp.Types.NPod.VolumeCount"> <summary> Number of volumes defined in this nPod </summary> </member> <member name="P:NebSharp.Types.NPod.VolumeGuids"> <summary> List of volume identifiers defined in this nPod </summary> </member> <member name="T:NebSharp.Types.NPodCustomDiagnostics"> <summary> Defines a custom diagnostics script <para> Custom diagnostics scripts are used by nebulon customer satisfaction when custom commands and diagnostics scripts need to be executed on SPUs in customers datacenters to resolve issues. </para> <para> Commands cannot be executed without customer approval as they need to be approved and authenticated through the security triangle. Custom diagnostics scripts are the vehicle to facilitate the security triangle. </para> </summary> </member> <member name="P:NebSharp.Types.NPodCustomDiagnostics.DiagnosticName"> <summary> Human readable name for the diagnostic script </summary> </member> <member name="P:NebSharp.Types.NPodCustomDiagnostics.Note"> <summary> An optional note for the diagnostics script </summary> </member> <member name="P:NebSharp.Types.NPodCustomDiagnostics.NPodGuid"> <summary> Unique identifier of the nPod on which the script should run </summary> </member> <member name="P:NebSharp.Types.NPodCustomDiagnostics.OnceOnly"> <summary> Indicates that the script will only be executed once </summary> </member> <member name="P:NebSharp.Types.NPodCustomDiagnostics.RequestGuid"> <summary> Unique identifier for the diagnostic script </summary> </member> <member name="T:NebSharp.Types.NPodFilter"> <summary> A filter object to filter nPods. <para> Allows filtering for specific nPods in nebulon ON.The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.NPodFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.NPodFilter.Name"> <summary> Filter based on nPod name </summary> </member> <member name="P:NebSharp.Types.NPodFilter.NPodGuid"> <summary> Filter based on nPod unique identifiers </summary> </member> <member name="P:NebSharp.Types.NPodFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="T:NebSharp.Types.NPodList"> <summary> Paginated nPod list object <para> Contains a list of nPod objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.NPodSpuInput"> <summary> An input object to configure SPUs for nPod creation. <para> Allows specifying SPU configuration options when creating a new nPod. Configuration is mostly for network configuration. </para> </summary> </member> <member name="P:NebSharp.Types.NPodSpuInput.DataIps"> <summary> Allows configuring the SPUs network interfaces. </summary> </member> <member name="P:NebSharp.Types.NPodSpuInput.Name"> <summary> Human readable name for a SPU </summary> </member> <member name="P:NebSharp.Types.NPodSpuInput.Serial"> <summary> Serial number for the SPU </summary> </member> <member name="T:NebSharp.Types.SetNPodTimeZoneInput"> <summary> Allows setting the timezone of an nPod or SPU </summary> </member> <member name="P:NebSharp.Types.SetNPodTimeZoneInput.Timezone"> <summary> The time zone to set </summary> </member> <member name="T:NebSharp.Types.CreateNPodTemplateInput"> <summary> An input object to create a new nPod template <para> nPod templates are used during nPod creation and are application specific. The template defines the anticipated data storage savings and the expected storage artifacts. Architects would compile nPod templates and users would consume templates during self-service infrastructure provisioning. </para> </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.Application"> <summary> The name of the application that will be running on the nPod. </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.BootImageURL"> <summary> Allows specifying an HTTP(s) URL for a boot image that is applied to the boot volume when an nPod is created. </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.BootVolume"> <summary> If set to <c>true</c> nebulon ON will provision a boot volume for the server's operating system. If set, the parameter <c>BootVolumeSizeBytes</c>must also be specified. </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.BootVolumeSizeBytes"> <summary> The size of the boot volume to create in bytes. This value is only considered when the parameter <c>BootVolume</c> is set to <c>true</c>. </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.MirroredVolume"> <summary> Specifies if volumes shall be mirrored for high availability. If set to <c>true</c> two copies of the same volume will be created in an nPod on different SPUs for high availability. </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.Name"> <summary> The name of the nPod template to update. The name cannot be changed. If users want to change the name of a nPod template they should clone the template with a new name and delete the old record </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.Note"> <summary> An optional note for the nPod template </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.OperatingSystem"> <summary> The name of the operating system that will be installed on servers in the nPod. </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.SavingFactor"> <summary> The anticipated saving factor for the specified application after data compression and data deduplication. Allowed values are between <c>1.0</c> and <c>10.0</c>. nebulon ON will use this assumption for provisioning storage volumes. </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.SharedLun"> <summary> Allows configuring volume export options. If set to <c>true</c> all volumes except boot volumes will be made available to each host / server in the nPod for read and write access. If set to <c>false</c> volumes will only be made available to the local host of every SPU. By default volumes are created as shared volumes. </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.SnapshotScheduleTemplateGuids"> <summary> Allows specifying snapshot schedule templates that will be automatically created for any derived nPods after nPod creation. </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.VolumeCount"> <summary> Allows specifying a volume count. This option is only allowed when <c>SharedVolume</c> is set to <c>false</c> and allows creating a specific number of volumes per host / server. This is useful when the size of the volume does not matter but the number of volumes is important. </summary> </member> <member name="P:NebSharp.Types.CreateNPodTemplateInput.VolumeSizeBytes"> <summary> The size of volumes to create in bytes. Either volume size or volume count must be present. </summary> </member> <member name="T:NebSharp.Types.NPodTemplate"> <summary> Defines a nebulon Pod (nPod) template <para> nPod templates are used during nPod creation and are application specific. The template defines the anticipated data storage savings and the expected storage artifacts. Architects would compile nPod templates and users would consume templates during self-service infrastructure provisioning. </para> </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.Application"> <summary> Name of the application running on the hosts in the nPod </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.BootVolume"> <summary> If true, the template will provision a boot volume that is exported to the local host with LUN ID 0 </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.BootVolumeImageUrl"> <summary> Allows specifying a URL to an O/S image for the boot volume </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.BootVolumeSizeBytes"> <summary> Indicates the boot volume size in bytes </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.Guid"> <summary> The unique identifier of the template if versioned </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.MirroredVolume"> <summary> If true, data volumes will be mirrored within the nPod. If false, no high availability is provided in case an SPU fails </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.Mutable"> <summary> Indicates if the template can be modified </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.Name"> <summary> The unique name of the nPod template </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.NebulonTemplate"> <summary> If true, the template is provided to customers by nebulon. If false, the template is custom and created by the customer </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.Note"> <summary> An optional note for the nPod template </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.OperatingSystem"> <summary> Name of the operating system running on the hosts in the nPod </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.ParentGuid"> <summary> The unique identifier of the original template if versioned </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.SavingFactor"> <summary> Anticipated data saving factor after compression and deduplication </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.SharedLun"> <summary> If true, data volumes will be presented to all hosts in the nPod. If this value is set to false, volumes will only be presented to the local hosts of each SPU </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.SnapshotScheduleTemplateGuids"> <summary> List of associated snapshot schedule templates contained in this template </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.Version"> <summary> The version of the template. Every update creates a new version </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.VolumeCount"> <summary> Indicates how many volumes shall be provisioned by the template </summary> </member> <member name="P:NebSharp.Types.NPodTemplate.VolumeSizeBytes"> <summary> Volume size in bytes </summary> </member> <member name="T:NebSharp.Types.NPodTemplateFilter"> <summary> A filter object to filter nPod templates. <para> Allows filtering for specific nPod templates in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.NPodTemplateFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.NPodTemplateFilter.Application"> <summary> Filter based on nPod template application name </summary> </member> <member name="P:NebSharp.Types.NPodTemplateFilter.Guid"> <summary> Filter based on nPod template unique identifier </summary> </member> <member name="P:NebSharp.Types.NPodTemplateFilter.Name"> <summary> Filter based on nPod template name </summary> </member> <member name="P:NebSharp.Types.NPodTemplateFilter.NebulonTempalte"> <summary> Filter nPod templates for nebulon templates or custom templates </summary> </member> <member name="P:NebSharp.Types.NPodTemplateFilter.OnlyLastVersion"> <summary> Filter nPod tempaltes for only the latest versions </summary> </member> <member name="P:NebSharp.Types.NPodTemplateFilter.OperatingSystem"> <summary> Filter based on nPod template operating system name </summary> </member> <member name="P:NebSharp.Types.NPodTemplateFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="T:NebSharp.Types.NPodTemplateList"> <summary> Paginated nPod template list object <para> Contains a list of nPod template objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.NPodTemplateSort"> <summary> A sort object for nPod templates <para> Allows sorting nPod templates on common properties.The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.NPodTemplateSort.Application"> <summary> Sort direction for the <c>Application</c> property </summary> </member> <member name="P:NebSharp.Types.NPodTemplateSort.Name"> <summary> Sort direction for the <c>Name</c> property </summary> </member> <member name="P:NebSharp.Types.NPodTemplateSort.OperatingSystem"> <summary> Sort direction for the <c>OperatingSystem</c> property </summary> </member> <member name="T:NebSharp.Types.UpdateNPodTemplateInput"> <summary> An input object to update nPod template properties <para> Every change to a nPod template will create a new version of the template and generate a new unique identifier (Guid). The parent / original nPod template is accessible via the nPod template <c>ParentGuid</c> property. </para> </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.Application"> <summary> The name of the application that will be running on the nPod. </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.BootImageURL"> <summary> Allows specifying an HTTP(s) URL for a boot image that is applied to the boot volume when an nPod is created. </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.BootVolume"> <summary> If set to <c>true</c> nebulon ON will provision a boot volume for the server's operating system. If set, the parameter <c>BootVolumeSizeBytes</c>must also be specified. </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.BootVolumeSizeBytes"> <summary> The size of the boot volume to create in bytes. This value is only considered when the parameter <c>BootVolume</c> is set to <c>true</c>. </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.MirroredVolume"> <summary> Specifies if volumes shall be mirrored for high availability. If set to <c>true</c> two copies of the same volume will be created in an nPod on different SPUs for high availability. </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.Name"> <summary> The name of the nPod template to update. The name cannot be changed. If users want to change the name of a nPod template they should clone the template with a new name and delete the old record </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.Note"> <summary> An optional note for the nPod template </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.OperatingSystem"> <summary> The name of the operating system that will be installed on servers in the nPod. </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.SavingFactor"> <summary> The anticipated saving factor for the specified application after data compression and data deduplication. Allowed values are between <c>1.0</c> and <c>10.0</c>. nebulon ON will use this assumption for provisioning storage volumes. </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.SharedLun"> <summary> Allows configuring volume export options. If set to <c>true</c> all volumes except boot volumes will be made available to each host / server in the nPod for read and write access. If set to <c>false</c> volumes will only be made available to the local host of every SPU. By default volumes are created as shared volumes. </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.SnapshotScheduleTemplateGuids"> <summary> Allows specifying snapshot schedule templates that will be automatically created for any derived nPods after nPod creation. </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.VolumeCount"> <summary> Allows specifying a volume count. This option is only allowed when <c>SharedVolume</c> is set to <c>false</c> and allows creating a specific number of volumes per host / server. This is useful when the size of the volume does not matter but the number of volumes is important. </summary> </member> <member name="P:NebSharp.Types.UpdateNPodTemplateInput.VolumeSizeBytes"> <summary> The size of volumes to create in bytes. Either volume size or volume count must be present. </summary> </member> <member name="T:NebSharp.Types.LocatePhysicalDriveInput"> <summary> An input object to turn on the physical drive locate LED <para> Allows turning on the locate LED of a physical drive identified by WWN to easily find it in a server. </para> </summary> </member> <member name="P:NebSharp.Types.LocatePhysicalDriveInput.DurationSeconds"> <summary> Number of seconds after which the locate LED will turn off </summary> </member> <member name="P:NebSharp.Types.LocatePhysicalDriveInput.Wwn"> <summary> The world-wide name of the physical drive </summary> </member> <member name="T:NebSharp.Types.PhysicalDrive"> <summary> A physical drive <para> Represents a physical drive that is attached to a services processing unit in a server. </para> </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.FirmwareRevision"> <summary> The firmware revision of the physical drive </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.InterfaceType"> <summary> The interface type of the physical drive </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.MediaType"> <summary> The media type of the physical drive </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.Model"> <summary> The model of the physical drive </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.Position"> <summary> The position or slot in the host's storage enclosure </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.Serial"> <summary> The serial number of the physical drive </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.SizeBytes"> <summary> The physical capacity of the physical drive in bytes </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.SpuSerial"> <summary> The serial number of the SPU that the physical drive connects to </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.State"> <summary> The physical drive state. <para>Possible values are:<br/> 1: PdNormal : normal<br/> 2: PdFailed: failed, can’t handle IO<br/> 3: PdMissing: device is missing<br/> 4: PdVacant: data on device has been vacated<br/> 5: PdIncompatible: device is incompatible to other devices<br/> </para> </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.StateDisplay"> <summary> The physical drive state as a string </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.Unadmitted"> <summary> Indicates if the physical drive is not yet used for data storage </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.Vendor"> <summary> The vendor for the physical drive </summary> </member> <member name="P:NebSharp.Types.PhysicalDrive.Wwn"> <summary> The unique world-wide name of the physical drive </summary> </member> <member name="T:NebSharp.Types.PhysicalDriveFilter"> <summary> A filter object to filter physical drives. <para> Allows filtering for specific physical drives in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveFilter.And"> <summary> Allows specifying more filters. This filter will be evaluated with a logical "and" operation. </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveFilter.InterfaceType"> <summary> Filter by interface type </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveFilter.Model"> <summary> Filter by drive model </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveFilter.Or"> <summary> Allows specifying more filters. This filter will be evaluated with a logical "or" operation. </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveFilter.SizeBytes"> <summary> Filter by drive size </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveFilter.Vendor"> <summary> Filter by drive vendor </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveFilter.Wwn"> <summary> Filter by WWN </summary> </member> <member name="T:NebSharp.Types.PhysicalDriveList"> <summary> Paginated physical drive list object <para> Contains a list of datacenter objects and information for pagination.By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.PhysicalDriveSort"> <summary> A sort object for physical drives <para> Allows sorting physical drives on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveSort.InterfaceType"> <summary> Sort direction for the interface type </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveSort.Model"> <summary> Sort direction for model </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveSort.SizeBytes"> <summary> Sort direction for the drive size </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveSort.Vendor"> <summary> Sort direction for drive vendor </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveSort.Wwn"> <summary> Sort direction for WWN </summary> </member> <member name="T:NebSharp.Types.PhysicalDriveUpdate"> <summary> An update for a physical drive <para> nebulon ON only reports recommended physical drive updates. </para> </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdate.Model"> <summary> The model of the physical drive this update is relevant for </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdate.NewFirmwareRev"> <summary> The firmware revision this update will install </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdate.OldFirmwareRev"> <summary> The firmware revision this update replaces </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdate.PodGuid"> <summary> The unique identifier of the nPod this update is relevant for </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdate.SpuSerial"> <summary> The serial number of the SPU this update is relevant for </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdate.Vendor"> <summary> The vendor of the physical drive this update is relevant for </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdate.Wwn"> <summary> The unique WWN of the physical drive this update is relevant for </summary> </member> <member name="T:NebSharp.Types.PhysicalDriveUpdatesFilter"> <summary> A filter object to filter physical drive updates <para> Allows filtering for specific physical drive updates in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdatesFilter.And"> <summary> Allows specifying more filters. This filter will be evaluated with a logical "and" operation. </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdatesFilter.NPodGuid"> <summary> Filter by nPod Guid </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdatesFilter.Or"> <summary> Allows specifying more filters. This filter will be evaluated with a logical "or" operation. </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdatesFilter.SpuSerial"> <summary> Filter by SPU serial number </summary> </member> <member name="T:NebSharp.Types.PhysicalDriveUpdatesList"> <summary> Paginated physical drive update list object <para> Contains a list of physical drive update objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.PhysicalDriveUpdatesSort"> <summary> A sort object for physical drive updates <para> Allows sorting physical drive updates on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdatesSort.Model"> <summary> Sort by physical drive model </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdatesSort.NPodGuid"> <summary> Sort by NPod Guid </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdatesSort.SpuSerial"> <summary> Sort by SPU serial number </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdatesSort.Vendor"> <summary> Sort by vendor </summary> </member> <member name="P:NebSharp.Types.PhysicalDriveUpdatesSort.Wwn"> <summary> Sort by world wide name </summary> </member> <member name="T:NebSharp.Types.UpdatePhysicalDriveFirmwareInput"> <summary> An input object to update physical drive firmware <para> Allows updating all physical drives in an SPU or nPod to the recommended drive firmware level. </para> </summary> </member> <member name="P:NebSharp.Types.UpdatePhysicalDriveFirmwareInput.AcceptEula"> <summary> Indicates if the user accepts the end user license agreement </summary> </member> <member name="P:NebSharp.Types.UpdatePhysicalDriveFirmwareInput.NPodGuid"> <summary> The nPod unique identifier </summary> </member> <member name="P:NebSharp.Types.UpdatePhysicalDriveFirmwareInput.SpuSerial"> <summary> The SPU serial number </summary> </member> <member name="T:NebSharp.Types.CreateRackInput"> <summary> An input object to create a rack <para> Allows the creation of a rack object in nebulon ON. A rack record allows customers to logically organize their infrastructure by physical location. </para> </summary> </member> <member name="P:NebSharp.Types.CreateRackInput.Location"> <summary> An optional location for the new rack </summary> </member> <member name="P:NebSharp.Types.CreateRackInput.Name"> <summary> Name for the new rack </summary> </member> <member name="P:NebSharp.Types.CreateRackInput.Note"> <summary> An optional note for the new rack </summary> </member> <member name="P:NebSharp.Types.CreateRackInput.RowGuid"> <summary> Unique identifier for the parent row </summary> </member> <member name="T:NebSharp.Types.Rack"> <summary> A rack in a datacenter <para> A rack record allows customers to logically organize their infrastructure by physical location. </para> </summary> </member> <member name="P:NebSharp.Types.Rack.Guid"> <summary> Unique identifier for the rack </summary> </member> <member name="P:NebSharp.Types.Rack.HostCount"> <summary> Number of hosts (servers) in the rack </summary> </member> <member name="P:NebSharp.Types.Rack.HostGuids"> <summary> Unique identifiers of hosts in the rack </summary> </member> <member name="P:NebSharp.Types.Rack.Location"> <summary> An optional location for the rack </summary> </member> <member name="P:NebSharp.Types.Rack.Name"> <summary> Name of the rack </summary> </member> <member name="P:NebSharp.Types.Rack.Note"> <summary> An optional note for the rack </summary> </member> <member name="P:NebSharp.Types.Rack.RowGuid"> <summary> Unique identifier of the parent row </summary> </member> <member name="T:NebSharp.Types.RackFilter"> <summary> A filter object to filter racks. <para> Allows filtering for specific racks in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.RackFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.RackFilter.Guid"> <summary> Filter based on rack unique identifier </summary> </member> <member name="P:NebSharp.Types.RackFilter.Location"> <summary> Filter based on rack location </summary> </member> <member name="P:NebSharp.Types.RackFilter.Name"> <summary> Filter based on rack name </summary> </member> <member name="P:NebSharp.Types.RackFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="P:NebSharp.Types.RackFilter.RowGuid"> <summary> Filter based on the rack's row unique identifier </summary> </member> <member name="T:NebSharp.Types.RackList"> <summary> Paginated rack list object <para> Contains a list of rack objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.RackSort"> <summary> A sort object for racks <para> Allows sorting racks on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.RackSort.Name"> <summary> Sort direction for the <c>Name</c> property </summary> </member> <member name="T:NebSharp.Types.UpdateRackInput"> <summary> An input object to update rack properties <para> Allows updating of an existing rack object in nebulon ON. A rack record allows customers to logically organize their infrastructure by physical location. </para> </summary> </member> <member name="P:NebSharp.Types.UpdateRackInput.Location"> <summary> A new optional location for the rack </summary> </member> <member name="P:NebSharp.Types.UpdateRackInput.Name"> <summary> The new name of the rack </summary> </member> <member name="P:NebSharp.Types.UpdateRackInput.Note"> <summary> The new note of the rack </summary> </member> <member name="P:NebSharp.Types.UpdateRackInput.RowGuid"> <summary> Unique identifier for a new row for the rack </summary> </member> <member name="T:NebSharp.Types.CreateRbacPolicyInput"> <summary> An input object to create a RBAC policy <para> Policies in role-based access control associate RBAC roles with users and resources in nebulon ON. Scopes can be added and removed from policies, users and user groups can be added and removed from policies. Nebulon ON will not allow two policies with the same definition. </para> <para> Scopes are defined through a string with the format <c>/nPodGroup/{npod_group_uuid}/nPod/{npod_uuid}</c> with varying length. For example:<br/> - <c>/nPodGroup/*</c>: scopes the policy to all nPod groups in the organization<br/> - <c>/nPodGroup/{npod_group_uuid}/nPod/*</c>: scopes the policy to a specific nPod group in the organization and all nPods in this group. - <c>/nPodGroup/{npod_group_uuid}/nPod/{npod_uuid}</c>: scopes the policy to a specific nPod. </para> <para> User groups are not added and removed from a policy through this API, but through the users API. Use <c>CreateUserGroup</c>, <c>UpdateUserGroup</c> for adding and removing user groups to RBAC policies and similarly <c>CreateUser</c> and <c>UpdateUser</c>. </para> </summary> </member> <member name="P:NebSharp.Types.CreateRbacPolicyInput.RoleGuid"> <summary> The RBAC role unique identifier to associate with the policy </summary> </member> <member name="P:NebSharp.Types.CreateRbacPolicyInput.Scopes"> <summary> List of scope definitions that this policy applies to </summary> </member> <member name="T:NebSharp.Types.CreateRbacRoleInput"> <summary> An input object to create a RBAC role <para> Roles in role-based access control define a set of permissions (rights) that can be assigned to user groups according to their responsibilities. Rights can be added and removed if these responsibilities change and propagate to any user that is associated with a role. </para> <para> Rights are defined through a string with the format <c>{resource}/{permission}</c>, where the following resources are available: <c>*</c>, <c>Datacenter</c>, <c>Lab</c>, <c>Audit</c>, <c>Alert</c>, <c>FirmwareUpdate</c>, <c>UserGroup</c>, <c>nPodGroup</c>, <c>Volume</c>, <c>PhysicalDrive</c>, <c>User</c>, <c>nPod</c>, <c>SnapshotScheduleTemplate</c>, <c>SPU</c>, <c>Row</c>, <c>Rack</c>, <c>nPodTemplate</c>, <c>SnapshotSchedule</c>, <c>Host</c>, <c>LUN</c>, <c>Webhook</c> </para> <para> The following permissions are available:<br/> <c>*</c> - everything is permitted<br/> <c>read</c> - read operations are permitted<br/> <c>create</c> - create operations are permitted<br/> <c>update</c> - update operations are permitted<br/> <c>delete</c> - delete operations are permitted<br/> <c>execute</c> - execute operations are permitted (used for operations that do not fall in the above categories) </para> <para> The number and type of permissions and resources may change over time and users can query the currently available resources and permissions with the <c>GetMetadata</c> query. </para> </summary> </member> <member name="P:NebSharp.Types.CreateRbacRoleInput.Description"> <summary> Description of the RBAC role and associated rights </summary> </member> <member name="P:NebSharp.Types.CreateRbacRoleInput.Name"> <summary> Human readable name for the RBAC role </summary> </member> <member name="P:NebSharp.Types.CreateRbacRoleInput.Rights"> <summary> List of rights definitions for the RBAC role </summary> </member> <member name="T:NebSharp.Types.RbacPolicy"> <summary> A RBAC policy object <para> Policies in role-based access control associate RBAC roles with users and resources in nebulon ON. Scopes can be added and removed from policies, users and user groups can be added and removed from policies. Nebulon ON will not allow two policies with the same definition. </para> <para> Scopes are defined through a string with the format <c>/nPodGroup/{npod_group_uuid}/nPod/{npod_uuid}</c> with varying length. For example:<br/> - <c>/nPodGroup/*</c>: scopes the policy to all nPod groups in the organization<br/> - <c>/nPodGroup/{npod_group_uuid}/nPod/*</c>: scopes the policy to a specific nPod group in the organization and all nPods in this group. - <c>/nPodGroup/{npod_group_uuid}/nPod/{npod_uuid}</c>: scopes the policy to a specific nPod. </para> <para> User groups are not added and removed from a policy through this API, but through the users API. Use <c>CreateUserGroup</c>, <c>UpdateUserGroup</c> for adding and removing user groups to RBAC policies and similarly <c>CreateUser</c> and <c>UpdateUser</c>. </para> </summary> </member> <member name="P:NebSharp.Types.RbacPolicy.Guid"> <summary> The unique identifier of the RBAC policy </summary> </member> <member name="P:NebSharp.Types.RbacPolicy.RoleGuid"> <summary> The unique identifier of the RBAC role in this policy </summary> </member> <member name="P:NebSharp.Types.RbacPolicy.Scopes"> <summary> List of scope definitions that this policy applies to </summary> </member> <member name="P:NebSharp.Types.RbacPolicy.UserGroupGuids"> <summary> List of unique identifiers of user groups in the RBAC policy </summary> </member> <member name="P:NebSharp.Types.RbacPolicy.UserGuids"> <summary> List of unique identifiers of explicit users in the RBAC policy </summary> </member> <member name="T:NebSharp.Types.RbacPolicyFilter"> <summary> A filter object to filter RBAC policies <para> Allows filtering for specific RBAC policies in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.RbacPolicyFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.RbacPolicyFilter.Guid"> <summary> Filter based on RBAC policy unique identifier </summary> </member> <member name="P:NebSharp.Types.RbacPolicyFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="P:NebSharp.Types.RbacPolicyFilter.RoleGuid"> <summary> Filter based on RBAC role unique identifier </summary> </member> <member name="T:NebSharp.Types.RbacPolicyList"> <summary> Paginated RBAC policy list object <para> Contains a list of RBAC policy objects and information for pagination.By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.RbacPolicySort"> <summary> A sort object for RBAC policies <para> Allows sorting RBAC policies on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.RbacPolicySort.Name"> <summary> Sort direction for the <c>Name</c> property </summary> </member> <member name="T:NebSharp.Types.RbacRole"> <summary> A role definition for role-based access control (RBAC) <para> Roles in role-based access control define a set of permissions (rights) that can be assigned to user groups according to their responsibilities. Rights can be added and removed if these responsibilities change and propagate to any user that is associated with a role. </para> <para> Rights are defined through a string with the format <c>{resource}/{permission}</c>, where the following resources are available: <c>*</c>, <c>Datacenter</c>, <c>Lab</c>, <c>Audit</c>, <c>Alert</c>, <c>FirmwareUpdate</c>, <c>UserGroup</c>, <c>nPodGroup</c>, <c>Volume</c>, <c>PhysicalDrive</c>, <c>User</c>, <c>nPod</c>, <c>SnapshotScheduleTemplate</c>, <c>SPU</c>, <c>Row</c>, <c>Rack</c>, <c>nPodTemplate</c>, <c>SnapshotSchedule</c>, <c>Host</c>, <c>LUN</c>, <c>Webhook</c> </para> <para> The following permissions are available:<br/> <c>*</c> - everything is permitted<br/> <c>read</c> - read operations are permitted<br/> <c>create</c> - create operations are permitted<br/> <c>update</c> - update operations are permitted<br/> <c>delete</c> - delete operations are permitted<br/> <c>execute</c> - execute operations are permitted (used for operations that do not fall in the above categories) </para> <para> The number and type of permissions and resources may change over time and users can query the currently available resources and permissions with the <c>GetMetadata</c> query. </para> </summary> </member> <member name="P:NebSharp.Types.RbacRole.Custom"> <summary> Indicates if the RBAC role was user defined </summary> </member> <member name="P:NebSharp.Types.RbacRole.Description"> <summary> Description of the RBAC role and associated rights </summary> </member> <member name="P:NebSharp.Types.RbacRole.Guid"> <summary> Unique identifier of the RBAC role </summary> </member> <member name="P:NebSharp.Types.RbacRole.Name"> <summary> Human readable name for the RBAC role </summary> </member> <member name="P:NebSharp.Types.RbacRole.Rights"> <summary> List of rights definitions for the RBAC role </summary> </member> <member name="T:NebSharp.Types.RbacRoleFilter"> <summary> A filter object to filter RBAC roles <para> Allows filtering for specific RBAC roles in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.RbacRoleFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.RbacRoleFilter.Guid"> <summary> Filter based on RBAC role unique identifier </summary> </member> <member name="P:NebSharp.Types.RbacRoleFilter.Name"> <summary> Filter based on RBAC role name </summary> </member> <member name="P:NebSharp.Types.RbacRoleFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="T:NebSharp.Types.RbacRoleList"> <summary> Paginated RBAC role list object Contains a list of RBAC role objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </summary> </member> <member name="T:NebSharp.Types.RbacRoleSort"> <summary> A sort object for RBAC roles <para> Allows sorting RBAC roles on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.RbacRoleSort.Name"> <summary> Sort direction for the <c>Name</c> property </summary> </member> <member name="T:NebSharp.Types.UpdateRbacPolicyInput"> <summary> An input object to update RBAC policy properties <para> Policies in role-based access control associate RBAC roles with users and resources in nebulon ON. Scopes can be added and removed from policies, users and user groups can be added and removed from policies. Nebulon ON will not allow two policies with the same definition. </para> <para> Scopes are defined through a string with the format <c>/nPodGroup/{npod_group_uuid}/nPod/{npod_uuid}</c> with varying length. For example:<br/> - <c>/nPodGroup/*</c>: scopes the policy to all nPod groups in the organization<br/> - <c>/nPodGroup/{npod_group_uuid}/nPod/*</c>: scopes the policy to a specific nPod group in the organization and all nPods in this group. - <c>/nPodGroup/{npod_group_uuid}/nPod/{npod_uuid}</c>: scopes the policy to a specific nPod. </para> <para> User groups are not added and removed from a policy through this API, but through the users API. Use <c>CreateUserGroup</c>, <c>UpdateUserGroup</c> for adding and removing user groups to RBAC policies and similarly <c>CreateUser</c> and <c>UpdateUser</c>. </para> </summary> </member> <member name="P:NebSharp.Types.UpdateRbacPolicyInput.Scopes"> <summary> List of scope definitions that this policy applies to </summary> </member> <member name="T:NebSharp.Types.UpdateRbacRoleInput"> <summary> An input object to update properties a RBAC role <para> Roles in role-based access control define a set of permissions (rights) that can be assigned to user groups according to their responsibilities. Rights can be added and removed if these responsibilities change and propagate to any user that is associated with a role. </para> <para> Rights are defined through a string with the format <c>{resource}/{permission}</c>, where the following resources are available: <c>*</c>, <c>Datacenter</c>, <c>Lab</c>, <c>Audit</c>, <c>Alert</c>, <c>FirmwareUpdate</c>, <c>UserGroup</c>, <c>nPodGroup</c>, <c>Volume</c>, <c>PhysicalDrive</c>, <c>User</c>, <c>nPod</c>, <c>SnapshotScheduleTemplate</c>, <c>SPU</c>, <c>Row</c>, <c>Rack</c>, <c>nPodTemplate</c>, <c>SnapshotSchedule</c>, <c>Host</c>, <c>LUN</c>, <c>Webhook</c> </para> <para> The following permissions are available:<br/> <c>*</c> - everything is permitted<br/> <c>read</c> - read operations are permitted<br/> <c>create</c> - create operations are permitted<br/> <c>update</c> - update operations are permitted<br/> <c>delete</c> - delete operations are permitted<br/> <c>execute</c> - execute operations are permitted (used for operations that do not fall in the above categories) </para> <para> The number and type of permissions and resources may change over time and users can query the currently available resources and permissions with the <c>GetMetadata</c> query. </para> </summary> </member> <member name="P:NebSharp.Types.UpdateRbacRoleInput.Description"> <summary> Description of the RBAC role and associated rights </summary> </member> <member name="P:NebSharp.Types.UpdateRbacRoleInput.Name"> <summary> Human readable name for the RBAC role </summary> </member> <member name="P:NebSharp.Types.UpdateRbacRoleInput.Rights"> <summary> List of rights definitions for the RBAC role </summary> </member> <member name="T:NebSharp.Types.RecipeState"> <summary> Status of the recipe execution </summary> </member> <member name="F:NebSharp.Types.RecipeState.Queued"> <summary> Recipe is queued for execution </summary> </member> <member name="F:NebSharp.Types.RecipeState.Running"> <summary> Recipe is running </summary> </member> <member name="F:NebSharp.Types.RecipeState.Completed"> <summary> Recipe execution completed successfully </summary> </member> <member name="F:NebSharp.Types.RecipeState.Failed"> <summary> Recipe execution completed with a failure </summary> </member> <member name="F:NebSharp.Types.RecipeState.Timeout"> <summary> Recipe execution timed out </summary> </member> <member name="F:NebSharp.Types.RecipeState.Cancelling"> <summary> Recipe execution is being canceled </summary> </member> <member name="F:NebSharp.Types.RecipeState.Cancelled"> <summary> Recipe execution completed by a cancelation </summary> </member> <member name="T:NebSharp.Types.RecipeType"> <summary> Type of recipe </summary> </member> <member name="F:NebSharp.Types.RecipeType.Unknown"> <summary> Recipe type is unknown </summary> </member> <member name="F:NebSharp.Types.RecipeType.Claim"> <summary> Claim SPU </summary> </member> <member name="F:NebSharp.Types.RecipeType.CreateVolume"> <summary> Create volume </summary> </member> <member name="F:NebSharp.Types.RecipeType.CreatePod"> <summary> Create nPod </summary> </member> <member name="F:NebSharp.Types.RecipeType.ValidatePod"> <summary> Validate nPod </summary> </member> <member name="F:NebSharp.Types.RecipeType.ConfirmPod"> <summary> Confirm nPod </summary> </member> <member name="F:NebSharp.Types.RecipeType.CreateSnapshot"> <summary> Create snapshot </summary> </member> <member name="F:NebSharp.Types.RecipeType.CreateScheduledSnapshot"> <summary> Create snapshot via a schedule </summary> </member> <member name="F:NebSharp.Types.RecipeType.Update"> <summary> Update SPU or nPod </summary> </member> <member name="F:NebSharp.Types.RecipeType.AbortUpdate"> <summary> Abort SPU or nPod update </summary> </member> <member name="F:NebSharp.Types.RecipeType.RemoveSnapshotSchedule"> <summary> Remove snapshot schedule </summary> </member> <member name="F:NebSharp.Types.RecipeType.SendSPUDebugInfo"> <summary> Send SPU debug information to nebulon ON </summary> </member> <member name="F:NebSharp.Types.RecipeType.RunTest"> <summary> Run test </summary> </member> <member name="F:NebSharp.Types.RecipeType.WipePod"> <summary> Wipe nPod </summary> </member> <member name="F:NebSharp.Types.RecipeType.DeleteVolume"> <summary> Delete volume </summary> </member> <member name="F:NebSharp.Types.RecipeType.SetVSphereCredentials"> <summary> Set vCenter credentials </summary> </member> <member name="F:NebSharp.Types.RecipeType.ResetOrganization"> <summary> Reset organization </summary> </member> <member name="F:NebSharp.Types.RecipeType.PingSPU"> <summary> Locate / ping SPU </summary> </member> <member name="F:NebSharp.Types.RecipeType.CreateLUN"> <summary> Create LUN </summary> </member> <member name="F:NebSharp.Types.RecipeType.DeleteLUN"> <summary> Delete LUN </summary> </member> <member name="F:NebSharp.Types.RecipeType.SetProxy"> <summary> Set Proxy Server information </summary> </member> <member name="F:NebSharp.Types.RecipeType.SetNTP"> <summary> Set network time protocol server </summary> </member> <member name="F:NebSharp.Types.RecipeType.UpdatePhysicalDrive"> <summary> Update physical drive </summary> </member> <member name="F:NebSharp.Types.RecipeType.SetTimezone"> <summary> Set timezone </summary> </member> <member name="F:NebSharp.Types.RecipeType.CloneVolume"> <summary> Clone volume </summary> </member> <member name="F:NebSharp.Types.RecipeType.LocatePhysicalDrive"> <summary> Locate physical drive </summary> </member> <member name="F:NebSharp.Types.RecipeType.ReplaceSPU"> <summary> Replace SPU </summary> </member> <member name="F:NebSharp.Types.RecipeType.SecureEraseSPU"> <summary> Secure erase SPU </summary> </member> <member name="T:NebSharp.Types.NPodRecipeFilter"> <summary> A filter object to filter recipes. <para> Allows filtering active and completed recipes. Recipes are the result of mutations of mutations or modifications of on-premises infrastructure. As commands may require some time to complete, the recipe filter allows the query for their status. </para> </summary> </member> <member name="P:NebSharp.Types.NPodRecipeFilter.Completed"> <summary> Filter based on completion status </summary> </member> <member name="P:NebSharp.Types.NPodRecipeFilter.NPodGuid"> <summary> Filter based on nPod unique identifier </summary> </member> <member name="P:NebSharp.Types.NPodRecipeFilter.RecipeGuid"> <summary> Filter based on nPod recipe unique identifier </summary> </member> <member name="T:NebSharp.Types.RecipeRecord"> <summary> A recipe record <para> A recipe record describes the status of the execution of a mutation that affects on-premises infrastructure. Status information of such mutations are recorded in recipe records. </para> </summary> </member> <member name="P:NebSharp.Types.RecipeRecord.CancelGuid"> <summary> A unique identifier that can be used to cancel recipe execution </summary> </member> <member name="P:NebSharp.Types.RecipeRecord.CoordinatorSpuSerial"> <summary> Serial number of the SPU that coordinates the execution of the recipe within a nPod </summary> </member> <member name="P:NebSharp.Types.RecipeRecord.CreatedAfter"> <summary> The unique identifier for the nPod that this recipe is associated with </summary> </member> <member name="P:NebSharp.Types.RecipeRecord.Guid"> <summary> The unique identifier of the recipe record </summary> </member> <member name="P:NebSharp.Types.RecipeRecord.LastUpdated"> <summary> Date and time when the recipe was last updated </summary> </member> <member name="P:NebSharp.Types.RecipeRecord.Start"> <summary> Date and time when the recipe started execution </summary> </member> <member name="P:NebSharp.Types.RecipeRecord.State"> <summary> Current state of recipe execution </summary> </member> <member name="P:NebSharp.Types.RecipeRecord.Status"> <summary> Textual description of the recipe execution status </summary> </member> <member name="P:NebSharp.Types.RecipeRecord.Type"> <summary> The type of recipe that is executed </summary> </member> <member name="T:NebSharp.Types.RecipeRecordIdentifier"> <summary> A reference to a recipe <para> This object is created and returned to a caller for recipe engine version 2 calls to allow the caller to query for the status of recipe execution </para> </summary> </member> <member name="P:NebSharp.Types.RecipeRecordIdentifier.NPodGuid"> <summary> The unique identifier of the nPod the recipe is executed for </summary> </member> <member name="P:NebSharp.Types.RecipeRecordIdentifier.RecipeGuid"> <summary> The unique identifier of the recipe generated </summary> </member> <member name="T:NebSharp.Types.RecipeRecordList"> <summary> Paginated nPod recipe list object Contains a list of nPod recipes objects. At this point all recipes are returned in a single page. </summary> </member> <member name="P:NebSharp.Types.RecipeRecordList.cursor"> <summary> A cursor that can be used (in the future) for pagination </summary> </member> <member name="P:NebSharp.Types.RecipeRecordList.Items"> <summary> List of nPod recipies </summary> </member> <member name="T:NebSharp.Types.CreateRoomInput"> <summary> An input object to create a datacenter room <para> Allows the creation of a datacenter room object in nebulon ON. A datacenter room record allows customers to logically organize their infrastructure by physical location. </para> </summary> </member> <member name="P:NebSharp.Types.CreateRoomInput.DataCenterGuid"> <summary> Unique identifier for the parent datacenter </summary> </member> <member name="P:NebSharp.Types.CreateRoomInput.Location"> <summary> An optional location for the new datacenter room </summary> </member> <member name="P:NebSharp.Types.CreateRoomInput.Name"> <summary> Name for the new datacenter room </summary> </member> <member name="P:NebSharp.Types.CreateRoomInput.Note"> <summary> An optional note for the new datacenter room </summary> </member> <member name="T:NebSharp.Types.DeleteRoomInput"> <summary> An input object to delete a datacenter room object <para> Allows additional options when deleting a datacenter room.When cascade is set to <c>true</c> all child resources are deleted with the datacenter room if no hosts are associated with the datacenter room. </para> </summary> </member> <member name="P:NebSharp.Types.DeleteRoomInput.Cascade"> <summary> Indicates that child items shall be deleted with the room </summary> </member> <member name="T:NebSharp.Types.Room"> <summary> A datacenter room object <para> A datacenter room record allows customers to logically organize their infrastructure by physical location. </para> </summary> </member> <member name="P:NebSharp.Types.Room.DatacenterGuid"> <summary> Unique identifier of the datacenter room </summary> </member> <member name="P:NebSharp.Types.Room.HostCount"> <summary> Number of hosts (servers) in the datacenter room </summary> </member> <member name="P:NebSharp.Types.Room.LabGuid"> <summary> Unique identifier of the parent datacenter </summary> </member> <member name="P:NebSharp.Types.Room.Location"> <summary> An optional location for the datacenter room </summary> </member> <member name="P:NebSharp.Types.Room.Name"> <summary> Name of the datacenter room </summary> </member> <member name="P:NebSharp.Types.Room.Note"> <summary> An optional note for the datacenter room </summary> </member> <member name="P:NebSharp.Types.Room.RackCount"> <summary> Number of racks in the datacenter room </summary> </member> <member name="P:NebSharp.Types.Room.RowCount"> <summary> Number of rows in the datacenter room </summary> </member> <member name="P:NebSharp.Types.Room.RowGuids"> <summary> Unique identifiers of rows in the datacenter room </summary> </member> <member name="T:NebSharp.Types.RoomFilter"> <summary> A filter object to filter datacenter rooms <para> Allows filtering for specific datacenters in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.RoomFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.RoomFilter.DatacenterGuid"> <summary> Filter based on datacenter unique identifier </summary> </member> <member name="P:NebSharp.Types.RoomFilter.Name"> <summary> Filter based on datacenter room name </summary> </member> <member name="P:NebSharp.Types.RoomFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="P:NebSharp.Types.RoomFilter.RoomGuid"> <summary> Filter based on datacenter room unique identifiers </summary> </member> <member name="T:NebSharp.Types.RoomList"> <summary> Paginated datacenter room list object <para> Contains a list of datacenter room objects and information for pagination.By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.RoomSort"> <summary> A sort object for rooms <para> Allows sorting rooms in datacenters on common properties.The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.RoomSort.Name"> <summary> Sort direction for the <c>Name</c>name property </summary> </member> <member name="T:NebSharp.Types.UpdateRoomInput"> <summary> An input object to update datacenter room properties <para> Allows updating of an existing datacenter room object in nebulon ON. A datacenter room record allows customers to logically organize their infrastructure by physical location. </para> </summary> </member> <member name="P:NebSharp.Types.UpdateRoomInput.Location"> <summary> A new optional location for the datacenter room </summary> </member> <member name="P:NebSharp.Types.UpdateRoomInput.Name"> <summary> New name for the datacenter room </summary> </member> <member name="P:NebSharp.Types.UpdateRoomInput.Note"> <summary> The new note for the datacenter room </summary> </member> <member name="T:NebSharp.Types.CreateRowInput"> <summary> An input object to create a row <para> Allows the creation of a row object in nebulon ON. A row record allows customers to logically organize their infrastructure by physical location. </para> </summary> </member> <member name="P:NebSharp.Types.CreateRowInput.Location"> <summary> An optional location for the new row </summary> </member> <member name="P:NebSharp.Types.CreateRowInput.Name"> <summary> Name for the new row </summary> </member> <member name="P:NebSharp.Types.CreateRowInput.Note"> <summary> An optional note for the new row </summary> </member> <member name="P:NebSharp.Types.CreateRowInput.RoomGuid"> <summary> Unique identifier for the parent room </summary> </member> <member name="T:NebSharp.Types.DeleteRowInput"> <summary> An input object to delete a row object <para> Allows additional options when deleting a row. When cascade is set to <c>true</c> all child resources are deleted with the datacenter room if no hosts are associated with the datacenter room. </para> </summary> </member> <member name="P:NebSharp.Types.DeleteRowInput.Cascade"> <summary> If set to <i>true</i> all child objects of the row will also be deleted. This includes racks. This will also unlink all affected racks with their hosts. </summary> </member> <member name="T:NebSharp.Types.Row"> <summary> A row object <para> A row record allows customers to logically organize their infrastructure by physical location. </para> </summary> </member> <member name="P:NebSharp.Types.Row.Guid"> <summary> Unique identifier of the row </summary> </member> <member name="P:NebSharp.Types.Row.HostCount"> <summary> Number of hosts (servers) in the row </summary> </member> <member name="P:NebSharp.Types.Row.Location"> <summary> An optional location for the row </summary> </member> <member name="P:NebSharp.Types.Row.Name"> <summary> Name of the row </summary> </member> <member name="P:NebSharp.Types.Row.Note"> <summary> An optional note for the row </summary> </member> <member name="P:NebSharp.Types.Row.RackCount"> <summary> Number of racks in the row </summary> </member> <member name="P:NebSharp.Types.Row.RackGuids"> <summary> Unique identifiers of racks in the row </summary> </member> <member name="P:NebSharp.Types.Row.RoomGuid"> <summary> Unique identifier of the parent room </summary> </member> <member name="T:NebSharp.Types.RowFilter"> <summary> A filter object to filter rows in a datacenter. <para> Allows filtering for specific rows in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.RowFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.RowFilter.Guid"> <summary> Filter based on row unique identifier </summary> </member> <member name="P:NebSharp.Types.RowFilter.Location"> <summary> Filter based on location </summary> </member> <member name="P:NebSharp.Types.RowFilter.Name"> <summary> Filter based on row name </summary> </member> <member name="P:NebSharp.Types.RowFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="P:NebSharp.Types.RowFilter.RoomGuid"> <summary> Filter based on the room's row unique identifier </summary> </member> <member name="T:NebSharp.Types.RowList"> <summary> Paginated row list object <para> Contains a list of row objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.RowSort"> <summary> A sort object for rows <para> Allows sorting rows on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.RowSort.Name"> <summary> Sort direction for the row name </summary> </member> <member name="T:NebSharp.Types.UpdateRowInput"> <summary> An input object to update row properties <para> Allows updating of an existing row object in nebulon ON. A row record allows customers to logically organize their infrastructure by physical location. </para> </summary> </member> <member name="P:NebSharp.Types.UpdateRowInput.Location"> <summary> An optional location for the new row </summary> </member> <member name="P:NebSharp.Types.UpdateRowInput.Name"> <summary> Name for the new row </summary> </member> <member name="P:NebSharp.Types.UpdateRowInput.Note"> <summary> An optional note for the new row </summary> </member> <member name="P:NebSharp.Types.UpdateRowInput.RoomGuid"> <summary> Unique identifier for the parent room </summary> </member> <member name="T:NebSharp.Types.LoginResults"> <summary> Result of a login request </summary> </member> <member name="P:NebSharp.Types.LoginResults.EulaAccepted"> <summary> Indicates if a user in the org has accepted the EULA </summary> </member> <member name="P:NebSharp.Types.LoginResults.Expiration"> <summary> Describes when the session will expire </summary> </member> <member name="P:NebSharp.Types.LoginResults.Message"> <summary> A message describing the login result </summary> </member> <member name="P:NebSharp.Types.LoginResults.Organization"> <summary> The name of the organization the user logged in </summary> </member> <member name="P:NebSharp.Types.LoginResults.Preferences"> <summary> User preferences associated with the logged in user </summary> </member> <member name="P:NebSharp.Types.LoginResults.Success"> <summary> Indicates if the login was successful </summary> </member> <member name="P:NebSharp.Types.LoginResults.UserGuid"> <summary> The unique identifier of the user that logged in </summary> </member> <member name="T:NebSharp.Types.LoginState"> <summary> Represents the session state of a user </summary> </member> <member name="P:NebSharp.Types.LoginState.Expiration"> <summary> Describes when the session expires </summary> </member> <member name="P:NebSharp.Types.LoginState.Organization"> <summary> Name of the organization for this session </summary> </member> <member name="P:NebSharp.Types.LoginState.UserGuid"> <summary> The user identifier of the user for this session </summary> </member> <member name="P:NebSharp.Types.LoginState.Username"> <summary> The name of the user for this session </summary> </member> <member name="T:NebSharp.Types.SnapshotConsistencyLevel"> <summary> Defines the snapshot consistency level for snapshots </summary> </member> <member name="F:NebSharp.Types.SnapshotConsistencyLevel.VV"> <summary> Consistency is only guaranteed for a single volume </summary> </member> <member name="F:NebSharp.Types.SnapshotConsistencyLevel.SPU"> <summary> Consistency is only quaranteed for volumes on the same SPU </summary> </member> <member name="F:NebSharp.Types.SnapshotConsistencyLevel.Pod"> <summary> Consistency is guaranteed for all volumes in the same nPod </summary> </member> <member name="T:NebSharp.Types.CreateCloneInput"> <summary> An input object to create a volume clone <para> Allows the creation of a volume clone from a base volume or snapshot. Clones are read and writeable copies of another volume. Clones can be used to quickly instantiate copies of data and data for recovery purposes when applications require read/write access for copy operations. </para> </summary> </member> <member name="P:NebSharp.Types.CreateCloneInput.Name"> <summary> Name for the volume clone </summary> </member> <member name="P:NebSharp.Types.CreateCloneInput.VolumeGuid"> <summary> Unique identifier of the volume or snapshot to clone </summary> </member> <member name="T:NebSharp.Types.CreateSnapshotScheduleTemplateInput"> <summary> An input object to create a snapshot schedule template <para> Allows the creation of snapshot schedule templates.Snapshot schedule templates are used to consistently provision snapshot schedules across nPods. They are referenced in nPod templates and are provisioned when a nPod is formed from such a template. </para> </summary> </member> <member name="P:NebSharp.Types.CreateSnapshotScheduleTemplateInput.ExpirationSeconds"> <summary> A time in seconds when snapshots will be automatically deleted. If not specified, snapshots will not be deleted automatically (not recommended). </summary> </member> <member name="P:NebSharp.Types.CreateSnapshotScheduleTemplateInput.IgnoreBootVolume"> <summary> Allows specifying if boot volumes shall be included when doing snapshots (<c>true</c>) or if they shall be ignored (<c>false</c>). By default, all volumes are included. </summary> </member> <member name="P:NebSharp.Types.CreateSnapshotScheduleTemplateInput.Name"> <summary> Human readable name for the snapshot schedule template </summary> </member> <member name="P:NebSharp.Types.CreateSnapshotScheduleTemplateInput.NamePattern"> <summary> A naming pattern for volume snapshot names when snapshots are automatically created. Available variables for the format string are from the standard <c>strftime</c> function. Additionally <c>%v</c> is used for the base volume name. </summary> </member> <member name="P:NebSharp.Types.CreateSnapshotScheduleTemplateInput.RetentionSeconds"> <summary> A time in seconds that prevents users from deleting snapshots. If not specified, snapshots can be immediately deleted. </summary> </member> <member name="P:NebSharp.Types.CreateSnapshotScheduleTemplateInput.Schedule"> <summary> The schedule by which volume snapshots will be created </summary> </member> <member name="T:NebSharp.Types.NPodSnapshotSchedule"> <summary> A snapshot schedule that is defined for an entire nPod <para> nPod snapshot schedules are defined for the entire nPod vs. for individual volumes. They are centrally configured through a template or on-demand and apply to every volume in an nPod. </para> </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.ConsistencyLevel"> <summary> Defines the consistency level when snapshotting multiple volumes </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.DayOfMonth"> <summary> The days in the month when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.DayOfWeek"> <summary> The days of the week when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.ExpirationSeconds"> <summary> A time in seconds when snapshots will be automatically deleted. If not specified, snapshots will not be deleted automatically (not recommended). </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.Guid"> <summary> The unique identifier for the nPod snapshot schedule </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.Hour"> <summary> The hours of the time when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.IgnoreBootVolume"> <summary> Allows specifying if boot volumes shall be included when doing snapshots (<c>true</c>) or if they shall be ignored (<c>false</c>). By default, all volumes are included. </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.Minute"> <summary> The minutes of the time when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.Month"> <summary> The months in the year when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.NamePattern"> <summary> A naming pattern for volume snapshot names when snapshots are automatically created. Available variables for the format string are from the standard <c>strftime</c> function. Additionally <c>%v</c> is used for the base volume name. </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.RetentionSeconds"> <summary> A time in seconds that prevents users from deleting snapshots. If not specified, snapshots can be immediately deleted. </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.SnapshotCount"> <summary> The number of nPod templates that make use of this template </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.SnapshotGuids"> <summary> The number of snapshots created from this schedule </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.SnapshotScheduleTemplateGuids"> <summary> Unique identifiers of the templates that created this schedule </summary> </member> <member name="P:NebSharp.Types.NPodSnapshotSchedule.SpuSerial"> <summary> The SPU serial number on which the schedule is defined </summary> </member> <member name="T:NebSharp.Types.Schedule"> <summary> A schedule object <para> Schedules are used to perform operations automatically. The schedule defines when and how often the operations are executed. </para> </summary> </member> <member name="P:NebSharp.Types.Schedule.DayOfMonth"> <summary> The days in the month when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.Schedule.DayOfWeek"> <summary> The days of the week when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.Schedule.Hour"> <summary> The hours of the time when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.Schedule.Minute"> <summary> The minutes of the time when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.Schedule.Month"> <summary> The months in the year when an operation should be executed </summary> </member> <member name="T:NebSharp.Types.ScheduleInput"> <summary> An input object to create a schedule <para> Schedules are used to perform operations automatically. The schedule defines when and how often the operations are executed. </para> <para> Multiple values for <c>Minute</c>, <c>Hour</c>, <c>DayOfWeek</c>, <c>DayOfMonth</c>, and <c>Month</c> can be specified when the operation should be executed multiple times in the respective time frame. </para> </summary> </member> <member name="P:NebSharp.Types.ScheduleInput.DayOfMonth"> <summary> The days in the month when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.ScheduleInput.DayOfWeek"> <summary> The days of the week when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.ScheduleInput.Hour"> <summary> The hours of the time when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.ScheduleInput.Minute"> <summary> The minutes of the time when an operation should be executed </summary> </member> <member name="P:NebSharp.Types.ScheduleInput.Month"> <summary> The months in the year when an operation should be executed </summary> </member> <member name="T:NebSharp.Types.SnapshotScheduleTemplate"> <summary> A snapshot schedule template object <para> Snapshot schedule templates are used to consistently provision snapshot schedules across nPods. They are referenced in nPod templates and are provisioned when a nPod is formed from such a template. </para> </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplate.AssociatedNPodTempalteCount"> <summary> The number of nPod templates that make use of this template </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplate.AssociatedScheduleCount"> <summary> The number of provisioned snapshot schedules from this template </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplate.ConsistencyLevel"> <summary> Snapshot consistency level. Always set to <c>Volume</c> </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplate.ExpirationSeconds"> <summary> A time in seconds when snapshots will be automatically deleted. If not specified, snapshots will not be deleted automatically (not recommended). </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplate.Guid"> <summary> The unique identifier of the snapshot schedule template </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplate.IgnoreBootVolume"> <summary> Allows specifying if boot volumes shall be included when doing snapshots (<c>true</c>) or if they shall be ignored (<c>false</c>). By default, all volumes are included. </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplate.Name"> <summary> Human readable name for the snapshot schedule template </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplate.NamePattern"> <summary> A naming pattern for volume snapshot names when snapshots are automatically created. Available variables for the format string are from the standard <c>strftime</c> function. Additionally <c>%v</c> is used for the base volume name. </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplate.RetentionSeconds"> <summary> A time in seconds that prevents users from deleting snapshots. If not specified, snapshots can be immediately deleted. </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplate.Schedule"> <summary> The schedule by which volume snapshots will be created </summary> </member> <member name="T:NebSharp.Types.SnapshotScheduleTemplateFilter"> <summary> A filter object to filter snapshot schedule templates <para> Allows filtering for specific snapshot schedule templates in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplateFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplateFilter.Guid"> <summary> Filter based on snapshot schedule template unique identifier </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplateFilter.Name"> <summary> Filter based on snapshot schedule template name </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplateFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="T:NebSharp.Types.SnapshotScheduleTemplateList"> <summary> Paginated snapshot schedule template list <para> Contains a list of snapshot schedule template objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.SnapshotScheduleTemplateSort"> <summary> A sort object for snapshot schedule templates <para> Allows sorting snapshot schedule templates on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.SnapshotScheduleTemplateSort.Name"> <summary> Sort direction for the <c>Name</c> property </summary> </member> <member name="T:NebSharp.Types.UpdateSnapshotScheduleTemplateInput"> <summary> An input object to update snapshot schedule template properties <para> Allows updating of snapshot schedule template properties. Snapshot schedule templates are used to consistently provision snapshot schedules across nPods. They are referenced in nPod templates and are provisioned when a nPod is formed from such a template. </para> </summary> </member> <member name="P:NebSharp.Types.UpdateSnapshotScheduleTemplateInput.ExpirationSeconds"> <summary> A time in seconds when snapshots will be automatically deleted. If not specified, snapshots will not be deleted automatically (not recommended). </summary> </member> <member name="P:NebSharp.Types.UpdateSnapshotScheduleTemplateInput.IgnoreBootVolume"> <summary> Allows specifying if boot volumes shall be included when doing snapshots (<c>true</c>) or if they shall be ignored (<c>false</c>). By default, all volumes are included. </summary> </member> <member name="P:NebSharp.Types.UpdateSnapshotScheduleTemplateInput.Name"> <summary> Human readable name for the snapshot schedule template </summary> </member> <member name="P:NebSharp.Types.UpdateSnapshotScheduleTemplateInput.NamePattern"> <summary> A naming pattern for volume snapshot names when snapshots are automatically created. Available variables for the format string are from the standard <c>strftime</c> function. Additionally <c>%v</c> is used for the base volume name. </summary> </member> <member name="P:NebSharp.Types.UpdateSnapshotScheduleTemplateInput.RetentionSeconds"> <summary> A time in seconds that prevents users from deleting snapshots. If not specified, snapshots can be immediately deleted. </summary> </member> <member name="P:NebSharp.Types.UpdateSnapshotScheduleTemplateInput.Schedule"> <summary> The schedule by which volume snapshots will be created </summary> </member> <member name="T:NebSharp.Types.IPInfoState"> <summary> A state for IP configuration of a SPU logical network interface </summary> </member> <member name="P:NebSharp.Types.IPInfoState.Addresses"> <summary> List of IPv4 or IPv6 addresses in CIDR format </summary> </member> <member name="P:NebSharp.Types.IPInfoState.BondLACPTransmitRate"> <summary> The active LACP transmit rate for the link aggregation </summary> </member> <member name="P:NebSharp.Types.IPInfoState.BondMIIMonitorMilliSeconds"> <summary> The active MII monitoring interval in ms for the link aggregation </summary> </member> <member name="P:NebSharp.Types.IPInfoState.BondMode"> <summary> The link aggregation mode for the interface </summary> </member> <member name="P:NebSharp.Types.IPInfoState.BondTransmitHashPolicy"> <summary> The active transmit hash policy for the link aggregation </summary> </member> <member name="P:NebSharp.Types.IPInfoState.Dhcp"> <summary> Indicates if DHCP is used for IP addressing </summary> </member> <member name="P:NebSharp.Types.IPInfoState.Gateway"> <summary> The gateway IP address specified for the interface </summary> </member> <member name="P:NebSharp.Types.IPInfoState.HalfDuplex"> <summary> Indicates if the interface operates in half-duplex </summary> </member> <member name="P:NebSharp.Types.IPInfoState.InterfaceMAC"> <summary> The physical address of the interface </summary> </member> <member name="P:NebSharp.Types.IPInfoState.InterfaceNames"> <summary> The names of the physical interfaces for the logical interface </summary> </member> <member name="P:NebSharp.Types.IPInfoState.LockedSpeed"> <summary> Indicates if the network interface speed is locked </summary> </member> <member name="P:NebSharp.Types.IPInfoState.Mtu"> <summary> maximum transfer unit </summary> </member> <member name="P:NebSharp.Types.IPInfoState.Speed"> <summary> Indicates the network interface speed </summary> </member> <member name="P:NebSharp.Types.IPInfoState.SwitchMAC"> <summary> The name of the switch this interface connects to </summary> </member> <member name="P:NebSharp.Types.IPInfoState.SwitchName"> <summary> The name of the switch this interface connects to </summary> </member> <member name="P:NebSharp.Types.IPInfoState.SwitchPort"> <summary> The port identifier of the switch this interface connects to </summary> </member> <member name="T:NebSharp.Types.NTPServer"> <summary> A network time protocol server <para> NTP servers are used for automatic time configuration on the services processing unit (SPU). </para> </summary> </member> <member name="P:NebSharp.Types.NTPServer.Pool"> <summary> Indicates if the specified NTP server hostname is a NTP pool </summary> </member> <member name="P:NebSharp.Types.NTPServer.Prefer"> <summary> Indicates if the specified NTP server is the preferred NTP server </summary> </member> <member name="P:NebSharp.Types.NTPServer.ServerHostname"> <summary> The DNS hostname of the NTP server </summary> </member> <member name="T:NebSharp.Types.NTPServerInput"> <summary> An input object to configure a NTP server <para> NTP servers are used for automatic time configuration on the services processing unit (SPU). The SPU has default network time servers (NTP) configured. However, customers can customize them if the default NTP servers are not accessible or different time settings are required. </para> </summary> </member> <member name="P:NebSharp.Types.NTPServerInput.Pool"> <summary> Indicates if the specified NTP server hostname is a NTP pool </summary> </member> <member name="P:NebSharp.Types.NTPServerInput.Prefer"> <summary> Indicates if the specified NTP server is the preferred NTP server </summary> </member> <member name="P:NebSharp.Types.NTPServerInput.ServerHostname"> <summary> The DNS hostname of the NTP server </summary> </member> <member name="T:NebSharp.Types.ReplaceSpuInput"> <summary> An input object to replace a services processing unit (SPU) <para> The replace services processing unit (SPU) operation is used to transition the configuration of an old, likely failed, SPU to a new replacement unit and allows modifying the configuration during the process. </para> </summary> </member> <member name="P:NebSharp.Types.ReplaceSpuInput.NewSpuInfo"> <summary> Configuration information for the new SPU </summary> </member> <member name="P:NebSharp.Types.ReplaceSpuInput.NPodGuid"> <summary> The unique identifier of the nPod of the old SPU that is being replaced </summary> </member> <member name="P:NebSharp.Types.ReplaceSpuInput.PreviousSpuSerial"> <summary> The serial number of the old SPU that is being replaced </summary> </member> <member name="P:NebSharp.Types.ReplaceSpuInput.SsetGuid"> <summary> The storage set information for the existing SPU. This information can be obtained from the active replacement alert and only used to verify that the correct SPU is selected </summary> </member> <member name="T:NebSharp.Types.SecureEraseSpuInput"> <summary> An input object to secure-erase a services processing unit (SPU) <para> The secure erase functionality allows a deep-erase of data stored on the physical drives attached to the SPU.Only SPUs that are not part of a nPod can be secure-erased. </para> </summary> </member> <member name="P:NebSharp.Types.SecureEraseSpuInput.SpuSerial"> <summary> The serial number of the SPU </summary> </member> <member name="T:NebSharp.Types.SetNTPServerInput"> <summary> An input object to configure NTP servers <para> NTP servers are used for automatic time configuration on the services processing unit(SPU). The SPU has default network time servers (NTP) configured. However, customers can customize them if the default NTP servers are not accessible or different time settings are required. </para> </summary> </member> <member name="P:NebSharp.Types.SetNTPServerInput.NPodGuid"> <summary> The unique identifier of the nPod </summary> </member> <member name="P:NebSharp.Types.SetNTPServerInput.Servers"> <summary> List of NTP server configurations that shall be applied to an SPU </summary> </member> <member name="P:NebSharp.Types.SetNTPServerInput.SpuSerial"> <summary> The serial number of the services processing unit </summary> </member> <member name="T:NebSharp.Types.Spu"> <summary> A services processing unit (SPU) </summary> </member> <member name="P:NebSharp.Types.Spu.ControlInterface"> <summary> Network information for the control interface </summary> </member> <member name="P:NebSharp.Types.Spu.DataInterfaces"> <summary> Network information for the data interfaces </summary> </member> <member name="P:NebSharp.Types.Spu.HardwareRevision"> <summary> The hardware revision of the SPU </summary> </member> <member name="P:NebSharp.Types.Spu.HostGuid"> <summary> The unique identifier of the host the SPU is installed in </summary> </member> <member name="P:NebSharp.Types.Spu.LastReported"> <summary> Date and time when the SPU last reported state to nebulon ON </summary> </member> <member name="P:NebSharp.Types.Spu.LunCount"> <summary> Number of provisioned LUNs on the SPU </summary> </member> <member name="P:NebSharp.Types.Spu.LunGuids"> <summary> List of unique identifiers of LUNs provisioned on the SPU </summary> </member> <member name="P:NebSharp.Types.Spu.NPodGuid"> <summary> The services processing unit's nPod identifier </summary> </member> <member name="P:NebSharp.Types.Spu.NPodMemberCanTalkCount"> <summary> Number of SPUs that can successfully communicate with each other </summary> </member> <member name="P:NebSharp.Types.Spu.PhysicalDriveCount"> <summary> Number of physical drives attached to the SPU </summary> </member> <member name="P:NebSharp.Types.Spu.PhysicalDriveWwns"> <summary> List of WWNs for all physical drives attached to the SPU </summary> </member> <member name="P:NebSharp.Types.Spu.ResetReasonInt"> <summary> A integer representation of the reason why a SPU was reset </summary> </member> <member name="P:NebSharp.Types.Spu.ResetReasonString"> <summary> A string representation of the reason why a SPU was reset </summary> </member> <member name="P:NebSharp.Types.Spu.Serial"> <summary> The unique serial number of the SPU </summary> </member> <member name="P:NebSharp.Types.Spu.SpuType"> <summary> The type of SPU </summary> </member> <member name="P:NebSharp.Types.Spu.Timezone"> <summary> The configured time zone </summary> </member> <member name="P:NebSharp.Types.Spu.UEFIVersion"> <summary> Status message for NTP </summary> [JsonPath("$.ntpStatus", true)] public string NtpStatus { get; set; } <summary> Version for UEFI </summary> </member> <member name="P:NebSharp.Types.Spu.UpdateHistory"> <summary> List of historical updates that were applied to the SPU </summary> </member> <member name="P:NebSharp.Types.Spu.UptimeSeconds"> <summary> Uptime of the services processing unit in seconds </summary> </member> <member name="P:NebSharp.Types.Spu.Version"> <summary> The version of nebOS that is running on the SPU </summary> </member> <member name="P:NebSharp.Types.Spu.Wiping"> <summary> List of configured NTP servers </summary> [JsonPath("$.ntpServers", true)] public NTPServer[] NtpServers { get; set; } <summary> Indicates if the SPU is doing a secure wipe </summary> </member> <member name="T:NebSharp.Types.SpuCustomDiagnostic"> <summary> A staged custom diagnostics request <para> SPU custom diagnostics requests allows customers to run arbitrary diagnostic commands on the services processing units as part of troubleshooting issues during a support case. </para> </summary> </member> <member name="P:NebSharp.Types.SpuCustomDiagnostic.DiagnosticName"> <summary> The human readable name of the custom diagnostic request </summary> </member> <member name="P:NebSharp.Types.SpuCustomDiagnostic.Note"> <summary> An optional note for the diagnostic request </summary> </member> <member name="P:NebSharp.Types.SpuCustomDiagnostic.OnceOnly"> <summary> Indicates if this request will disappear after execution </summary> </member> <member name="P:NebSharp.Types.SpuCustomDiagnostic.RequestGuid"> <summary> The unique identifier or the custom diagnostic request </summary> </member> <member name="P:NebSharp.Types.SpuCustomDiagnostic.SpuSerial"> <summary> The serial number of the SPU on which to run diagnostic </summary> </member> <member name="T:NebSharp.Types.SpuFilter"> <summary> A filter object to filter services processing units (SPU) <para> Allows filtering for specific SPUs registered in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.SpuFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.SpuFilter.NotInNPod"> <summary> Filter for SPUs that are not in a nPod </summary> </member> <member name="P:NebSharp.Types.SpuFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="P:NebSharp.Types.SpuFilter.Serial"> <summary> Filter based on SPU serial number </summary> </member> <member name="T:NebSharp.Types.SpuList"> <summary> Paginated services processing unit (SPU) list <para> Contains a list of SPU objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.SpuSort"> <summary> A sort object for services processing units (SPU) <para> Allows sorting SPUs on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.SpuSort.Serial"> <summary> Sort direction for the <c>Serial</c> property </summary> </member> <member name="T:NebSharp.Types.SupportCaseIssueType"> <summary> Indicates the type of support case </summary> </member> <member name="F:NebSharp.Types.SupportCaseIssueType.Question"> <summary> Customer has a question </summary> </member> <member name="F:NebSharp.Types.SupportCaseIssueType.Hardware"> <summary> Suport case is related to a hardware issue </summary> </member> <member name="F:NebSharp.Types.SupportCaseIssueType.Software"> <summary> Support case is related to a software issue </summary> </member> <member name="F:NebSharp.Types.SupportCaseIssueType.FeatureRequest"> <summary> Customer has a feature request </summary> </member> <member name="F:NebSharp.Types.SupportCaseIssueType.Unknown"> <summary> Support case issue type is not known </summary> </member> <member name="T:NebSharp.Types.SupportCasePriority"> <summary> Indicates the customer specified priority for the support case </summary> </member> <member name="F:NebSharp.Types.SupportCasePriority.High"> <summary> High urgency </summary> </member> <member name="F:NebSharp.Types.SupportCasePriority.Medium"> <summary> Medium urgency </summary> </member> <member name="F:NebSharp.Types.SupportCasePriority.Low"> <summary> Low urgency </summary> </member> <member name="T:NebSharp.Types.SupportCaseStatus"> <summary> Indicates the status of the support case </summary> </member> <member name="F:NebSharp.Types.SupportCaseStatus.New"> <summary> A new support case </summary> </member> <member name="F:NebSharp.Types.SupportCaseStatus.Pending"> <summary> Work is pending information from the customer </summary> </member> <member name="F:NebSharp.Types.SupportCaseStatus.Working"> <summary> Customer support is actively working the support case </summary> </member> <member name="F:NebSharp.Types.SupportCaseStatus.Escalated"> <summary> The support case is escalated with customer support </summary> </member> <member name="F:NebSharp.Types.SupportCaseStatus.Closed"> <summary> The support case was resolved </summary> </member> <member name="T:NebSharp.Types.CreateSupportCaseInput"> <summary> An input object to create a new support case <para> Allows creation of a support case in nebulon ON. A support case allows customers to get their issues associated with nebulon Cloud-Defined Storage to be resolved with their preferred support channel. Issues may include infrastructure and hardware issues, software issues, or questions. </para> <para> Depending on the type of support case the required parameters change. At a minimum, customers need to supply a <c>subject</c> that describes the high level summary of the issue, a <c>description</c> that details their specific problem, a <c>priority</c> to indicate the urgency of the request, and the <c>issue_type</c> to better route the support case to the appropriate subject matter expert. </para> <para> If the issue is related to a specific services processing unit (SPU) or resource in nebulon ON or in the customer's datacenter, <c>spu_serial</c>, <c>resource_type</c>, and <c>resource_id</c> shall be specified. </para> </summary> </member> <member name="P:NebSharp.Types.CreateSupportCaseInput.Description"> <summary> Detailed description of the issue that requires resolution </summary> </member> <member name="P:NebSharp.Types.CreateSupportCaseInput.IssueType"> <summary> The type of issue. If the issue is not clearly identifiable, use <c>SupportCaseIssueType.Unknown</c>. </summary> </member> <member name="P:NebSharp.Types.CreateSupportCaseInput.Priority"> <summary> The urgency of the request </summary> </member> <member name="P:NebSharp.Types.CreateSupportCaseInput.ResourceId"> <summary> The unique identifier of the resource related to the support case. If <c>resourceType</c> is specified, also this parameter should be supplied. </summary> </member> <member name="P:NebSharp.Types.CreateSupportCaseInput.ResourceType"> <summary> The type of resource related to the support case </summary> </member> <member name="P:NebSharp.Types.CreateSupportCaseInput.SpuSerial"> <summary> The serial number of an SPU related to the support case. </summary> </member> <member name="P:NebSharp.Types.CreateSupportCaseInput.Subject"> <summary> High level summary of an issue </summary> </member> <member name="T:NebSharp.Types.SupportCase"> <summary> A support case object in nebulon ON. <para> A support case is used by customers to have their issues with nebulon infrastructure resolved. Issues may include infrastructure and hardware issues, software issues, or general questions. </para> </summary> </member> <member name="P:NebSharp.Types.SupportCase.AlertId"> <summary> Unique identifier of the associated alert for the support case </summary> </member> <member name="P:NebSharp.Types.SupportCase.Attachments"> <summary> List of attachments for the support case </summary> </member> <member name="P:NebSharp.Types.SupportCase.ClosedDate"> <summary> Date and time when the support case / issue was resolved </summary> </member> <member name="P:NebSharp.Types.SupportCase.Comments"> <summary> List of comments for the support case </summary> </member> <member name="P:NebSharp.Types.SupportCase.Contact"> <summary> The customer contact for the support case </summary> </member> <member name="P:NebSharp.Types.SupportCase.CreatedDate"> <summary> Date and time when the support case was created </summary> </member> <member name="P:NebSharp.Types.SupportCase.Description"> <summary> Detailed description of the support case / issue </summary> </member> <member name="P:NebSharp.Types.SupportCase.ImprovementSuggestion"> <summary> Customer feedback for improving future requests </summary> </member> <member name="P:NebSharp.Types.SupportCase.IssueType"> <summary> Type of issue </summary> </member> <member name="P:NebSharp.Types.SupportCase.KnowledgeBaseLink"> <summary> Knowledge Base article related to this support case </summary> </member> <member name="P:NebSharp.Types.SupportCase.Number"> <summary> Support case number </summary> </member> <member name="P:NebSharp.Types.SupportCase.OemCaseNumber"> <summary> Support case number with the server vendor </summary> </member> <member name="P:NebSharp.Types.SupportCase.OemCreatedDate"> <summary> Date and time of support case creation with the server vendor </summary> </member> <member name="P:NebSharp.Types.SupportCase.OemName"> <summary> Name of the server vendor associated with the infrastructure </summary> </member> <member name="P:NebSharp.Types.SupportCase.OemUpdatedDate"> <summary> Date and time of last update with the server vendor </summary> </member> <member name="P:NebSharp.Types.SupportCase.OwnerEmail"> <summary> The email of the case owner working the support case in support </summary> </member> <member name="P:NebSharp.Types.SupportCase.OwnerName"> <summary> The case owner working the support case in support </summary> </member> <member name="P:NebSharp.Types.SupportCase.Priority"> <summary> Urgency of the support case </summary> </member> <member name="P:NebSharp.Types.SupportCase.ResourceId"> <summary> Unique identifier of the associated resource for the support case </summary> </member> <member name="P:NebSharp.Types.SupportCase.ResourceType"> <summary> Associated resource type for the support case </summary> </member> <member name="P:NebSharp.Types.SupportCase.SpuSerial"> <summary> Serial number of the associated SPU for the support case </summary> </member> <member name="P:NebSharp.Types.SupportCase.Status"> <summary> Status of the support case </summary> </member> <member name="P:NebSharp.Types.SupportCase.Subject"> <summary> High level summary of the support case / issue </summary> </member> <member name="P:NebSharp.Types.SupportCase.UpdatedDate"> <summary> Date and time when the support case was last updated </summary> </member> <member name="T:NebSharp.Types.SupportCaseAttachment"> <summary> A file attachment to a support case. <para> Allows customers to attach arbitrary data to a support case. Examples are screenshots of the user interface, log files from application servers, or other supporting data for resolving a support case. </para> </summary> </member> <member name="P:NebSharp.Types.SupportCaseAttachment.FileLink"> <summary> A link to the file where it is uploaded </summary> </member> <member name="P:NebSharp.Types.SupportCaseAttachment.FileName"> <summary> The name of the uploaded file </summary> </member> <member name="P:NebSharp.Types.SupportCaseAttachment.FileSizeBytes"> <summary> The size of the file in bytes </summary> </member> <member name="P:NebSharp.Types.SupportCaseAttachment.Guid"> <summary> The unique identifier of the uploaded file </summary> </member> <member name="P:NebSharp.Types.SupportCaseAttachment.UploadTime"> <summary> The date and time of upload </summary> </member> <member name="T:NebSharp.Types.SupportCaseComment"> <summary> A comment in the support case history. <para> Allows interaction between the customer and support for further clarification of issues or providing support case status updates. Customers and support can add comments to a support case for bi-directional communication. </para> </summary> </member> <member name="P:NebSharp.Types.SupportCaseComment.Text"> <summary> The text contents of the comment </summary> </member> <member name="P:NebSharp.Types.SupportCaseComment.Time"> <summary> The date and time when the comment was published </summary> </member> <member name="P:NebSharp.Types.SupportCaseComment.UserName"> <summary> The name of the user that published the comment </summary> </member> <member name="T:NebSharp.Types.SupportCaseContact"> <summary> Represents the user contact for a support case. <para> The support case contact is used by support to work on resolving an issue. By default the contact for a support case is the user that created the support case, but can be altered. </para> </summary> </member> <member name="P:NebSharp.Types.SupportCaseContact.ContactGuid"> <summary> The unique identifier of the contact </summary> </member> <member name="P:NebSharp.Types.SupportCaseContact.Email"> <summary> The email address of the contact </summary> </member> <member name="P:NebSharp.Types.SupportCaseContact.Mobile"> <summary> The mobile phone number of the contact </summary> </member> <member name="P:NebSharp.Types.SupportCaseContact.Name"> <summary> The name of the contact </summary> </member> <member name="P:NebSharp.Types.SupportCaseContact.Phone"> <summary> The phone number of the contact </summary> </member> <member name="T:NebSharp.Types.SupportCaseFilter"> <summary> A filter object to filter support cases. <para> Allows filtering for specific support cases in nebulon ON. The filter allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.SupportCaseFilter.ContactGuid"> <summary> Filter based on the support case contact </summary> </member> <member name="P:NebSharp.Types.SupportCaseFilter.IssueType"> <summary> Filter based on the support case type </summary> </member> <member name="P:NebSharp.Types.SupportCaseFilter.Number"> <summary> Filter based on the support case number </summary> </member> <member name="P:NebSharp.Types.SupportCaseFilter.Status"> <summary> Filter based on the support case status </summary> </member> <member name="T:NebSharp.Types.SupportCaseList"> <summary> Paginated support case list object. <para> Contains a list of support case objects and information for pagination.By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>more</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.SupportCaseSort"> <summary> A sort object for support cases <para> Allows sorting support cases on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.SupportCaseSort.CreatedDate"> <summary> Sort direction for the <c>CreatedDate</c> property of a support case </summary> </member> <member name="P:NebSharp.Types.SupportCaseSort.IssueType"> <summary> Sort direction for the <c>IssueType</c> property of a support case </summary> </member> <member name="P:NebSharp.Types.SupportCaseSort.Status"> <summary> Sort direction for the <c>Status</c> property of a support case </summary> </member> <member name="P:NebSharp.Types.SupportCaseSort.UpdatedDate"> <summary> Sort direction for the <c>UpdatedDate</c> property of a support case </summary> </member> <member name="T:NebSharp.Types.UpdateSupportCaseInput"> <summary> An input object to update an existing support case. <para> Allows updating of a support case in nebulon ON. A support case allows customers to get their issues associated with nebulon Cloud-Defined Storage to be resolved with their preferred support channel. Issues may include infrastructure and hardware issues, software issues, or questions. </para> </summary> </member> <member name="P:NebSharp.Types.UpdateSupportCaseInput.Comment"> <summary> A comment to add to the support case history </summary> </member> <member name="P:NebSharp.Types.UpdateSupportCaseInput.ContactUserGuid"> <summary> The identifier for the user to be contacted for the support case </summary> </member> <member name="P:NebSharp.Types.UpdateSupportCaseInput.Description"> <summary> Detailed description of the issue that requires resolution </summary> </member> <member name="P:NebSharp.Types.UpdateSupportCaseInput.ImprovementSuggestion"> <summary> Feedback for support for improvement </summary> </member> <member name="P:NebSharp.Types.UpdateSupportCaseInput.Priority"> <summary> The urgency of the request </summary> </member> <member name="P:NebSharp.Types.UpdateSupportCaseInput.Status"> <summary> The new status of the support case </summary> </member> <member name="P:NebSharp.Types.UpdateSupportCaseInput.Subject"> <summary> High level summary of an issue </summary> </member> <member name="T:NebSharp.Types.MustSendTargetDns"> <summary> Used in mutations for on-premises infrastructure via security triangle. <para> Represents a definition of SPUs that a security token needs to be sent to. </para> </summary> </member> <member name="P:NebSharp.Types.MustSendTargetDns.ControlPortDns"> <summary> The DNS name of the SPU's control port </summary> </member> <member name="P:NebSharp.Types.MustSendTargetDns.DataPortDns"> <summary> List of DNS names of the SPU's data ports </summary> </member> <member name="T:NebSharp.Types.NPodTokenResponse"> <summary> Token response when creating a new nPod </summary> </member> <member name="P:NebSharp.Types.NPodTokenResponse.Issues"> <summary> List of errors and warnings associated with the mutation </summary> </member> <member name="P:NebSharp.Types.NPodTokenResponse.TokenResponse"> <summary> Token that needs to be delivered to on-premises SPUs </summary> </member> <member name="T:NebSharp.Types.TokenResponse"> <summary> Used in mutations for on-premises infrastructure via security triangle <para> Represents a response for a mutation that alters the customers' on-premises infrastructure and requires the completion of the security triangle. </para> </summary> </member> <member name="P:NebSharp.Types.TokenResponse.Issues"> <summary> List of errors and warnings associated with the mutation </summary> </member> <member name="P:NebSharp.Types.TokenResponse.MustSendTargetDns"> <summary> List of data IP addresses of SPUs involved in the mutation </summary> </member> <member name="P:NebSharp.Types.TokenResponse.TargetDataIps"> <summary> List of data IP addresses of SPUs involved in the mutation </summary> </member> <member name="P:NebSharp.Types.TokenResponse.TargetIps"> <summary> List of control IP addresses of SPUs involved in the mutation </summary> </member> <member name="P:NebSharp.Types.TokenResponse.Token"> <summary> Token that needs to be delivered to on-premises SPUs </summary> </member> <member name="P:NebSharp.Types.TokenResponse.WaitOn"> <summary> Unique identifier of the resource that is about to be created </summary> </member> <member name="T:NebSharp.Types.PackagePriority"> <summary> Indicates the importance for installing a nebulon package </summary> </member> <member name="F:NebSharp.Types.PackagePriority.Normal"> <summary> Indicates a routing installation package </summary> </member> <member name="F:NebSharp.Types.PackagePriority.Critical"> <summary> Indicates a critical update </summary> </member> <member name="T:NebSharp.Types.PackageType"> <summary> Indicates the type of software package </summary> </member> <member name="F:NebSharp.Types.PackageType.Base"> <summary> Baseline package that includes major changes to nebOS </summary> </member> <member name="F:NebSharp.Types.PackageType.Patch"> <summary> A patch package that resolves a specific issue with nebOS </summary> </member> <member name="T:NebSharp.Types.PackageInfo"> <summary> A nebulon update package <para> Allows updating nebulon services processing units to a specific nebOS version. The package information object describes each released nebOS package. </para> </summary> </member> <member name="P:NebSharp.Types.PackageInfo.EligibleNPodGuids"> <summary> List of nPod unique identifiers that can install this package </summary> </member> <member name="P:NebSharp.Types.PackageInfo.PackageDeprecated"> <summary> Indicates it the package is deprecated and no longer available </summary> </member> <member name="P:NebSharp.Types.PackageInfo.PackageDescription"> <summary> Description for the package </summary> </member> <member name="P:NebSharp.Types.PackageInfo.PackageName"> <summary> The name of the nebulon update package </summary> </member> <member name="P:NebSharp.Types.PackageInfo.PackagePriority"> <summary> Indicates the importance for installing a nebulon package </summary> </member> <member name="P:NebSharp.Types.PackageInfo.PackageSizeBytes"> <summary> The size of the update package in bytes </summary> </member> <member name="P:NebSharp.Types.PackageInfo.PackageType"> <summary> Type of the nebOS installation package </summary> </member> <member name="P:NebSharp.Types.PackageInfo.PatchNumber"> <summary> The patch number if it is a patch </summary> </member> <member name="P:NebSharp.Types.PackageInfo.Prerequisites"> <summary> Describes the prerequisites for the package </summary> </member> <member name="P:NebSharp.Types.PackageInfo.ReleaseNotesUrl"> <summary> A URL to the release notes of the package </summary> </member> <member name="P:NebSharp.Types.PackageInfo.ReleaseUnix"> <summary> The release date as a UNIX timestamp </summary> </member> <member name="P:NebSharp.Types.PackageInfo.VersionNumber"> <summary> The version number if it is a nebOS package </summary> </member> <member name="T:NebSharp.Types.RecommendedPackages"> <summary> Recommended packages for customers <para> Recommended packages indicate the currently recommended packages for customers given their current version and hardware. </para> </summary> </member> <member name="P:NebSharp.Types.RecommendedPackages.BaseVersion"> <summary> Indicates the base version for the recommended package </summary> </member> <member name="P:NebSharp.Types.RecommendedPackages.PackageInfo"> <summary> Information concerning the update pacakge </summary> </member> <member name="P:NebSharp.Types.RecommendedPackages.PackageName"> <summary> The name of the package that is recommended </summary> </member> <member name="P:NebSharp.Types.RecommendedPackages.SpuType"> <summary> Indicates the type of SPU for which the package is recommended </summary> </member> <member name="T:NebSharp.Types.UpdateHistory"> <summary> An object describing past updates </summary> </member> <member name="P:NebSharp.Types.UpdateHistory.Finish"> <summary> Date and time when the update completed </summary> </member> <member name="P:NebSharp.Types.UpdateHistory.PackageName"> <summary> The name of the package that is installed </summary> </member> <member name="P:NebSharp.Types.UpdateHistory.Start"> <summary> Date and time when the update started </summary> </member> <member name="P:NebSharp.Types.UpdateHistory.Success"> <summary> Indicates if the update completed successfully </summary> </member> <member name="P:NebSharp.Types.UpdateHistory.UpdateGuid"> <summary> The identifier of the update </summary> </member> <member name="T:NebSharp.Types.UpdatePackages"> <summary> An object describing nebOS software packages <para> Describes software packages that are available for installation and recommended for customers. </para> </summary> </member> <member name="P:NebSharp.Types.UpdatePackages.Available"> <summary> List of available nebulon software packages </summary> </member> <member name="P:NebSharp.Types.UpdatePackages.Latest"> <summary> The latest available nebulon software package </summary> </member> <member name="P:NebSharp.Types.UpdatePackages.Recommended"> <summary> List or recommended nebulon software packages </summary> </member> <member name="T:NebSharp.Types.UpdateStateSpu"> <summary> An object describing the current state of an update installation </summary> </member> <member name="P:NebSharp.Types.UpdateStateSpu.DownloadProgressPercent"> <summary> Download progress in percent </summary> </member> <member name="P:NebSharp.Types.UpdateStateSpu.FailureLog"> <summary> Contains information about update errors </summary> </member> <member name="P:NebSharp.Types.UpdateStateSpu.LastChanged"> <summary> Date and time when the SPU last reported update status </summary> </member> <member name="P:NebSharp.Types.UpdateStateSpu.PackageName"> <summary> The name of the package that is installed </summary> </member> <member name="P:NebSharp.Types.UpdateStateSpu.RestartComplete"> <summary> Indicates if nebOS has completed the restart </summary> </member> <member name="P:NebSharp.Types.UpdateStateSpu.Restarting"> <summary> Indicates if nebOS is restarting </summary> </member> <member name="P:NebSharp.Types.UpdateStateSpu.SpuSerial"> <summary> The serial number for the SPU on which the update is installed </summary> </member> <member name="P:NebSharp.Types.UpdateStateSpu.StartedInstall"> <summary> Indicates if the SPU has started installing the SPU </summary> </member> <member name="P:NebSharp.Types.UpdateStateSpu.UpdateId"> <summary> The identifier of the update </summary> </member> <member name="P:NebSharp.Types.UpdateStateSpu.WaitingForSpuSerial"> <summary> Indicates if the SPU is waiting for a SPU to complete its update </summary> </member> <member name="T:NebSharp.Types.CreateUserGroupInput"> <summary> An input object to create a new user group in nebulon ON </summary> </member> <member name="P:NebSharp.Types.CreateUserGroupInput.Name"> <summary> The name of the user group" </summary> </member> <member name="P:NebSharp.Types.CreateUserGroupInput.Note"> <summary> An optional note for the user group </summary> </member> <member name="P:NebSharp.Types.CreateUserGroupInput.PolicyGuids"> <summary> List of RBAC policies associated with the user group </summary> </member> <member name="T:NebSharp.Types.UpdateUserGroupInput"> <summary> An input object to update properties of a user group in nebulon ON </summary> </member> <member name="P:NebSharp.Types.UpdateUserGroupInput.Name"> <summary> The name of the user group" </summary> </member> <member name="P:NebSharp.Types.UpdateUserGroupInput.Note"> <summary> An optional note for the user group </summary> </member> <member name="P:NebSharp.Types.UpdateUserGroupInput.PolicyGuids"> <summary> List of RBAC policies associated with the user group </summary> </member> <member name="T:NebSharp.Types.UserGroup"> <summary> A user group in nebulon ON <para> User groups allow grouping users for more convenient management of permissions and policies. </para> </summary> </member> <member name="P:NebSharp.Types.UserGroup.Guid"> <summary> The unique identifier of the user group in nebulon ON </summary> </member> <member name="P:NebSharp.Types.UserGroup.Name"> <summary> The name of the user group </summary> </member> <member name="P:NebSharp.Types.UserGroup.Note"> <summary> An optional note for the user </summary> </member> <member name="P:NebSharp.Types.UserGroup.PolicyGuids"> <summary> List of RBAC policies associated with the user group </summary> </member> <member name="P:NebSharp.Types.UserGroup.UserGuids"> <summary> List of user unique identifiers that are part of the group </summary> </member> <member name="T:NebSharp.Types.UserGroupFilter"> <summary> A filter object to filter user groups <para> Allows filtering for specific user groups in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.UserGroupFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.UserGroupFilter.Guid"> <summary> Filter based on users unique identifier </summary> </member> <member name="P:NebSharp.Types.UserGroupFilter.Name"> <summary> Filter based on user name </summary> </member> <member name="P:NebSharp.Types.UserGroupFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="T:NebSharp.Types.UserGroupList"> <summary> Paginated user group list <para> Contains a list of user group objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.UserGroupSort"> <summary> A sort object for user groups <para> Allows sorting user groups on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.UserGroupSort.Name"> <summary> Sort direction for the <c>Name</c> property </summary> </member> <member name="T:NebSharp.Types.SendNotificationType"> <summary> Defines a user's notification preferences </summary> </member> <member name="F:NebSharp.Types.SendNotificationType.Disabled"> <summary> No email notifications are sent to the user </summary> </member> <member name="F:NebSharp.Types.SendNotificationType.Instant"> <summary> The user will receive email notifications as events are triggered </summary> </member> <member name="F:NebSharp.Types.SendNotificationType.Daily"> <summary> The user will receive a daily digest of alerts over the last 24 hours </summary> </member> <member name="T:NebSharp.Types.CreateUserInput"> <summary> An input object to create a new user account in nebulon ON </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.BusinessPhone"> <summary> The business phone number of the user </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.Email"> <summary> The business email address for the user </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.FirstName"> <summary> The user's first name </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.GroupGuids"> <summary> Unique identifiers of user groups the user is part of </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.Inactive"> <summary> Indicates if the user is marked as inactive / disabled </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.LastName"> <summary> The user's last name </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.MobilePhone"> <summary> The mobile phone number of the user </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.Note"> <summary> An optional note for the user </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.Password"> <summary> The password of the user </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.PolicyGuids"> <summary> List of RBAC policies associated with the user </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.SendNotification"> <summary> The user's notification preferences for alerts </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.Timezone"> <summary> The user's time zone </summary> </member> <member name="P:NebSharp.Types.CreateUserInput.UserName"> <summary> User name. This is used to login to nebulon ON and must be unique across all users in nebulon ON. </summary> </member> <member name="T:NebSharp.Types.UpdateUserInput"> <summary> An input object to update properties of a user in nebulon ON </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.BusinessPhone"> <summary> The business phone number of the user </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.Email"> <summary> The business email address for the user </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.FirstName"> <summary> The user's first name </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.GroupGuids"> <summary> Unique identifiers of user groups the user is part of </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.Inactive"> <summary> Indicates if the user is marked as inactive / disabled </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.LastName"> <summary> The user's last name </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.MobilePhone"> <summary> The mobile phone number of the user </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.Note"> <summary> An optional note for the user </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.Password"> <summary> The password of the user </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.PolicyGuids"> <summary> List of RBAC policies associated with the user </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.SendNotification"> <summary> The user's notification preferences for alerts </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.Timezone"> <summary> The user's time zone </summary> </member> <member name="P:NebSharp.Types.UpdateUserInput.UserName"> <summary> User name. This is used to login to nebulon ON and must be unique across all users in nebulon ON. </summary> </member> <member name="T:NebSharp.Types.User"> <summary> A user in nebulon ON </summary> </member> <member name="P:NebSharp.Types.User.BusinessPhone"> <summary> The user's business phone number </summary> </member> <member name="P:NebSharp.Types.User.ChangePassword"> <summary> Indicates if the user has to change the password during next login </summary> </member> <member name="P:NebSharp.Types.User.Email"> <summary> The user's email address. </summary> </member> <member name="P:NebSharp.Types.User.FirstName"> <summary> The user's first name </summary> </member> <member name="P:NebSharp.Types.User.GroupGuids"> <summary> List of user group unique identifiers the user is part of </summary> </member> <member name="P:NebSharp.Types.User.Guid"> <summary> The unique identifier of the user in nebulon ON </summary> </member> <member name="P:NebSharp.Types.User.Inactive"> <summary> Indicates if the user is marked as inactive. If true, the user can't log in to nebulon ON. </summary> </member> <member name="P:NebSharp.Types.User.LastName"> <summary> Last name of the user </summary> </member> <member name="P:NebSharp.Types.User.MobilePhone"> <summary> Mobile phone number of the user </summary> </member> <member name="P:NebSharp.Types.User.Note"> <summary> An optional note for the user </summary> </member> <member name="P:NebSharp.Types.User.PolicyGuids"> <summary> List of RBAC policies associated with the user </summary> </member> <member name="P:NebSharp.Types.User.UserName"> <summary> The user name. This is used for login and must be unique across all users in nebulon ON </summary> </member> <member name="P:NebSharp.Types.User.UserPreferences"> <summary> The user's personal preferences </summary> </member> <member name="T:NebSharp.Types.UserFilter"> <summary> A filter object to filter users <para> Allows filtering for specific user objects in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.UserFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.UserFilter.Email"> <summary> Filter based on user email address </summary> </member> <member name="P:NebSharp.Types.UserFilter.Guid"> <summary> Filter based on users unique identifier </summary> </member> <member name="P:NebSharp.Types.UserFilter.Name"> <summary> Filter based on user name </summary> </member> <member name="P:NebSharp.Types.UserFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="T:NebSharp.Types.UserList"> <summary> Paginated user list <para> Contains a list of user objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.UserPreferences"> <summary> Settings and configuration options for a user <para> User preferences define settings and configuration options for individual user accounts in nebulon ON that are not globally configured. </para> </summary> </member> <member name="P:NebSharp.Types.UserPreferences.DateFormat"> <summary> Specifies the user's preferred date and time formatting </summary> </member> <member name="P:NebSharp.Types.UserPreferences.NotificationType"> <summary> Specifies if and the rate at which the user receives notifications </summary> </member> <member name="P:NebSharp.Types.UserPreferences.ShowBaseTwo"> <summary> Specifies if the user wants capacity values displayed in base2 </summary> </member> <member name="P:NebSharp.Types.UserPreferences.Timezone"> <summary> Specifies the time zone of the user </summary> </member> <member name="T:NebSharp.Types.UserPreferencesInput"> <summary> An input object to define user preferences <para> User preferences define settings and configuration options for individual user accounts in nebulon ON that are not globally configured. </para> </summary> </member> <member name="P:NebSharp.Types.UserPreferencesInput.DateFormat"> <summary> Specifies the user's preferred date and time formatting </summary> </member> <member name="P:NebSharp.Types.UserPreferencesInput.NotificationType"> <summary> Specifies if and the rate at which the user receives notifications </summary> </member> <member name="P:NebSharp.Types.UserPreferencesInput.ShowBaseTwo"> <summary> Specifies if the user wants capacity values displayed in base2 </summary> </member> <member name="P:NebSharp.Types.UserPreferencesInput.Timezone"> <summary> Specifies the time zone of the user </summary> </member> <member name="T:NebSharp.Types.UserSort"> <summary> A sort object for users <para> Allows sorting users on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.UserSort.Name"> <summary> Sort direction for the <c>Name</c> property </summary> </member> <member name="T:NebSharp.Types.VolumeSyncState"> <summary> Represents volume sync status for mirrored volumes </summary> </member> <member name="F:NebSharp.Types.VolumeSyncState.NotMirrored"> <summary> The volume is not mirrored </summary> </member> <member name="F:NebSharp.Types.VolumeSyncState.InSync"> <summary> The volume is healthy and all data is in-sync </summary> </member> <member name="F:NebSharp.Types.VolumeSyncState.Syncing"> <summary> The volume is unhealthy and data is currently synchronizing </summary> </member> <member name="F:NebSharp.Types.VolumeSyncState.Unsynced"> <summary> The volume is unhealthy and data is currently not synchronizing </summary> </member> <member name="F:NebSharp.Types.VolumeSyncState.Unknown"> <summary> The volume sync status is unavailable </summary> </member> <member name="T:NebSharp.Types.CreateVolumeInput"> <summary> An input object to create a new volume <para> One of <c>nPodGuid</c> or <c>ownerSpuSerial</c> must be provided. If <c>ownerSpuSerial</c> or <c>backupSpuSerial</c> are not provided, nebulon ON will automatically determine where the volume will be provisioned. </para> </summary> </member> <member name="P:NebSharp.Types.CreateVolumeInput.BackupSpuSerial"> <summary> Serial number of the services processing unit that should be the backup for this volume </summary> </member> <member name="P:NebSharp.Types.CreateVolumeInput.Force"> <summary> If set to true, warnings will be ignored during the creation of the volume. As an example, if there is not enough capacity available for the volume, this may yield in a warning that can be overwritten using this parameter. </summary> </member> <member name="P:NebSharp.Types.CreateVolumeInput.Mirrored"> <summary> If set to true, the volume will be setup with a mirrored configuration. This requires two or more services processing units in an nPod </summary> </member> <member name="P:NebSharp.Types.CreateVolumeInput.Name"> <summary> User friendly name for the volume </summary> </member> <member name="P:NebSharp.Types.CreateVolumeInput.NPodGuid"> <summary> Unique identifier of the nPod for this volume. If only this parameter is provide (no SPU serial numbers), nebulon ON will determine the best placement for the volume amongst all SPUs. </summary> </member> <member name="P:NebSharp.Types.CreateVolumeInput.OwnerSpuSerial"> <summary> Services processing unit serial number that should be the primary owner of the volume. If the volume is not created with mirroring enabled, this is the SPU where the volume will be created on. </summary> </member> <member name="P:NebSharp.Types.CreateVolumeInput.SizeBytes"> <summary> Size in bytes for the volume. Minimum size for the volume is 1 GiB and the maximum enforced size is 64 GiB. </summary> </member> <member name="T:NebSharp.Types.Volume"> <summary> A volume </summary> </member> <member name="P:NebSharp.Types.Volume.AccessibleByHostGuids"> <summary> List of host / server uuids that have access to the volume </summary> </member> <member name="P:NebSharp.Types.Volume.Boot"> <summary> Indicates if the volume is a boot volume </summary> </member> <member name="P:NebSharp.Types.Volume.CreationTime"> <summary> Date and time when the volume was created </summary> </member> <member name="P:NebSharp.Types.Volume.CurrentOwnerHostGuid"> <summary> Unique identifier of the host that currently owns this volume </summary> </member> <member name="P:NebSharp.Types.Volume.ExpirationTime"> <summary> Date and time when this volume will be automatically deleted </summary> </member> <member name="P:NebSharp.Types.Volume.Guid"> <summary> Unique identifier for this volume </summary> </member> <member name="P:NebSharp.Types.Volume.LunGuids"> <summary> List of uuids for all LUNs created for the volume </summary> </member> <member name="P:NebSharp.Types.Volume.Name"> <summary> Human readable name for the volume </summary> </member> <member name="P:NebSharp.Types.Volume.NaturalBackupHostGuid"> <summary> Unique identifier of the host that is normally the backup for this volume </summary> </member> <member name="P:NebSharp.Types.Volume.NaturalBackupSpuSerial"> <summary> Serial number of the SPU that is normally the backup for this volume </summary> </member> <member name="P:NebSharp.Types.Volume.NaturalOwnerHostGuid"> <summary> Unique identifier of the host that is normally the owner for this volume </summary> </member> <member name="P:NebSharp.Types.Volume.NaturalOwnerSpuSerial"> <summary> Serial number of the SPU that is normally the owner for this volume </summary> </member> <member name="P:NebSharp.Types.Volume.NPodGuid"> <summary> Unique identifier of the nPod that this volume is part of </summary> </member> <member name="P:NebSharp.Types.Volume.ReadOnlySnapshot"> <summary> If true, this volume is a read-only snapshot instead of a base volume. </summary> </member> <member name="P:NebSharp.Types.Volume.SizeBytes"> <summary> Size of the volume </summary> </member> <member name="P:NebSharp.Types.Volume.SnapshotGuids"> <summary> If the volume has snapshots, this references all snapshots that are based on this volume </summary> </member> <member name="P:NebSharp.Types.Volume.SnapshotParentGuid"> <summary> If the volume is a snapshot, this references the parent volume's unique identifier </summary> </member> <member name="P:NebSharp.Types.Volume.VolumeSyncState"> <summary> Indicates the health and sync state of the volume </summary> </member> <member name="P:NebSharp.Types.Volume.Wwn"> <summary> The world wide name for this volume </summary> </member> <member name="T:NebSharp.Types.VolumeFilter"> <summary> A filter object to filter volumes <para> Allows filtering for specific volumes registered in nebulon ON. The filter allows only one property to be specified. If filtering on multiple properties is needed, use the <c>And</c> and <c>Or</c> options to concatenate multiple filters. </para> </summary> </member> <member name="P:NebSharp.Types.VolumeFilter.And"> <summary> Allows concatenation of multiple filters via logical AND </summary> </member> <member name="P:NebSharp.Types.VolumeFilter.BaseOnly"> <summary> Filter for only base volumes </summary> </member> <member name="P:NebSharp.Types.VolumeFilter.CreationTime"> <summary> Filter based on creation time </summary> </member> <member name="P:NebSharp.Types.VolumeFilter.ExpirationTime"> <summary> Filter based on creation time </summary> </member> <member name="P:NebSharp.Types.VolumeFilter.Guid"> <summary> Filter by unique Id </summary> </member> <member name="P:NebSharp.Types.VolumeFilter.Name"> <summary> Filter based on volume name </summary> </member> <member name="P:NebSharp.Types.VolumeFilter.NPodGuid"> <summary> Filter based on nPod unique identifier </summary> </member> <member name="P:NebSharp.Types.VolumeFilter.Or"> <summary> Allows concatenation of multiple filters via logical OR </summary> </member> <member name="P:NebSharp.Types.VolumeFilter.ParentGuid"> <summary> Filter based on volume parent uuid </summary> </member> <member name="P:NebSharp.Types.VolumeFilter.SizeBytes"> <summary> Filter based on volume size </summary> </member> <member name="P:NebSharp.Types.VolumeFilter.SnapshotsOnly"> <summary> Filter for only snapshots </summary> </member> <member name="P:NebSharp.Types.VolumeFilter.Wwn"> <summary> Filter based on volume WWN </summary> </member> <member name="T:NebSharp.Types.VolumeList"> <summary> Paginated volume list <para> Contains a list of volume objects and information for pagination. By default a single page includes a maximum of <c>100</c> items unless specified otherwise in the paginated query. </para> <para> Consumers should always check for the property <c>More</c> as per default the server does not return the full list of alerts but only one page. </para> </summary> </member> <member name="T:NebSharp.Types.VolumeSort"> <summary> A sort object for volumes <para> Allows sorting volumes on common properties. The sort object allows only one property to be specified. </para> </summary> </member> <member name="P:NebSharp.Types.VolumeSort.CreationTime"> <summary> Sort direction for the <c>CreationTime</c> property </summary> </member> <member name="P:NebSharp.Types.VolumeSort.ExpirationTime"> <summary> Sort direction for the <c>ExpirationTime</c> property </summary> </member> <member name="P:NebSharp.Types.VolumeSort.Name"> <summary> Sort direction for the <c>Name</c> property </summary> </member> <member name="P:NebSharp.Types.VolumeSort.SizeBytes"> <summary> Sort direction for the <c>SizeBytes</c> property </summary> </member> <member name="P:NebSharp.Types.VolumeSort.Wwn"> <summary> Sort direction for the <c>Wwn</c> property </summary> </member> <member name="T:NebSharp.LogSeverity"> <summary> Severity of a message written to the log </summary> </member> <member name="F:NebSharp.LogSeverity.Debug"> <summary> Debug information </summary> </member> <member name="F:NebSharp.LogSeverity.Verbose"> <summary> Verbose information </summary> </member> <member name="F:NebSharp.LogSeverity.Warning"> <summary> Warnings </summary> </member> <member name="F:NebSharp.LogSeverity.Error"> <summary> Errors </summary> </member> <member name="T:NebSharp.NebConnection"> <summary> Nebulon connection </summary> </member> <member name="F:NebSharp.NebConnection.GRAPHQL_WAITTIME_MS"> <summary> Time in milliseconds to wait for a response from UCAPI. </summary> </member> <member name="F:NebSharp.NebConnection.TOKEN_WAITTIME_MS"> <summary> Time in milliseconds to wait for resource creation after token delivery. </summary> </member> <member name="F:NebSharp.NebConnection._assemblyVersion"> <summary> Version string for this binary </summary> </member> <member name="F:NebSharp.NebConnection._httpClient"> <summary> Reusable HTTP client. After login, this HTTP client will carry the session cookie until the user explicitly logs out. </summary> </member> <member name="F:NebSharp.NebConnection._httpHandler"> <summary> Custom HTTP Client handler. This is required to dynamically update Cookies for other paths in the same domain. </summary> </member> <member name="F:NebSharp.NebConnection._platform"> <summary> Platform string where this library is used </summary> </member> <member name="F:NebSharp.NebConnection._server"> <summary> Full UCAPI Server URI. By default this is https://ucapi.nebcloud.nebuloninc.com. </summary> </member> <member name="M:NebSharp.NebConnection.#ctor(System.String,System.String)"> <summary> Instantiate a new connection to Nebulon ON. This will not automatically log in a user. </summary> <param name="clientName">Allows specifying an application name for Auditing</param> <param name="clientVersion">Allows specifying an application version for Auditing</param> </member> <member name="P:NebSharp.NebConnection.Logger"> <summary> Log writer. Overwrite this if you need to write to a custom log, e.g. to a file or to a message queue. By default this will log to the Console. </summary> </member> <member name="M:NebSharp.NebConnection.DeliverToken(NebSharp.Types.TokenResponse)"> <summary> Sends a token (received by Nebulon ON) to one or more SPUs that are specified in the token. It will return true if at least one of the SPUs in the token accepted token delivery. It returns false if none are reachable. </summary> <param name="tokenResponse"> A valid nebulon token </param> <returns>True - if successful; False - if failed</returns> </member> <member name="M:NebSharp.NebConnection.DeliverTokenV2(NebSharp.Types.TokenResponse)"> <summary> Delivers the token to SPUs that support recipe engine v2 </summary> <param name="tokenResponse"> A valid nebulon token </param> <returns></returns> { </member> <member name="M:NebSharp.NebConnection.ObjectFromJObject(Newtonsoft.Json.Linq.JObject,System.Type)"> <summary> Converts a JObject to a .NET object as per the provided type name </summary> <param name="objectData">JObject data to convert</param> <param name="type">Target type</param> <returns>Populated object</returns> </member> <member name="M:NebSharp.NebConnection.RunMutation``1(System.String,NebSharp.GraphQLParameters)"> <summary> Run a mutation against Nebulon ON. This function should be used when you expect just a single item returned. </summary> <typeparam name="T">The Type of the target array</typeparam> <param name="name">Name of the mutation</param> <param name="parameters">Parameters for the mutation</param> <returns>Single item returned by the mutation</returns> </member> <member name="M:NebSharp.NebConnection.RunMutationMany``1(System.String,NebSharp.GraphQLParameters)"> <summary> Run a mutation against Nebulon ON </summary> <typeparam name="T">The Type of the target array</typeparam> <param name="name">Name of the mutation</param> <param name="parameters">Parameters for the mutation</param> <returns>List of items returned by the mutation</returns> </member> <member name="M:NebSharp.NebConnection.RunQuery``1(System.String,NebSharp.GraphQLParameters)"> <summary> Run a query against Nebulon ON. This function should be used when you expect just a single item returned. </summary> <typeparam name="T">The Type of the target array</typeparam> <param name="name">Name of the query</param> <param name="parameters">Parameters for the query</param> <returns>Single item returned by the query</returns> </member> <member name="M:NebSharp.NebConnection.RunQueryMany``1(System.String,NebSharp.GraphQLParameters)"> <summary> Run a query against Nebulon ON </summary> <typeparam name="T">The Type of the target array</typeparam> <param name="name">Name of the query</param> <param name="parameters">Parameters for the query</param> <returns>List of items returned by the query</returns> </member> <member name="M:NebSharp.NebConnection.GetQueryFields(System.Type,System.Boolean)"> <summary> Get all GraphQL fields to query for given a Type. The Type needs to have JsonPath attributes specified for its properties for them to be included. </summary> <param name="inputType">Type of the class</param> <param name="convert">Convert the fields to GraphQL</param> <returns>List of (nested) GrapQL fields</returns> </member> <member name="M:NebSharp.NebConnection.GraphQLFieldsFromJsonp(System.String[])"> <summary> Sorts, reduces and aggregates a list of JSONP queries into GraphQL fieldQuery. This is a recursive function and will convert <code>["b.c", "a", "b.d"]</code> into <code>["a","b{c,d}"]</code> </summary> <param name="fields">List of JSONP queries</param> <returns>List of (nested) GrapQL fields</returns> </member> <member name="M:NebSharp.NebConnection.ReadResponseBodyString(System.Net.Http.HttpResponseMessage)"> <summary> Extract the response body from an HTTP response. This method uses a global timeout variable defined in GRAPHQL_WAITTIME_MS </summary> <param name="response">Response to read the data from</param> <exception cref="T:System.TimeoutException"/> <returns>HTTP response body as string</returns> </member> <member name="M:NebSharp.NebConnection.CastObjects``1(System.Object[])"> <summary> Convert an array of generic object types securely into a specified type. If the cast is not successful, this method will use the type's default value. </summary> <typeparam name="T">The Type of the target array</typeparam> <param name="input">Array of generic objects to cast</param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.DeliverTokenString(NebSharp.Types.TokenResponse)"> <summary> Delivers the token to SPUs as a generic method. </summary> <param name="tokenResponse"></param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.Post(System.String,System.Net.Http.HttpContent)"> <summary> Make a blocking HTTP POST request to the specified URI. This method uses a global timeout variable defined in GRAPHQL_WAITTIME_MS. </summary> <param name="uri">URI to call</param> <param name="content">Contents of the request</param> <exception cref="T:System.TimeoutException"/> <returns>HttpResponse from the request</returns> </member> <member name="M:NebSharp.NebConnection.Run``1(NebSharp.GraphQLMethod)"> <summary> Execute a GraphQL method against nebulon on. </summary> <typeparam name="T">Type of the object that we expect as a response</typeparam> <param name="method">GraphQL method</param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.UpdateCookieForPath(System.Uri)"> <summary> This method is needed as the HTTP client will not store cookies for a domain but per path. This will create a new cookie for the specified path. </summary> <param name="uri">The URI for which to set the cookie</param> </member> <member name="M:NebSharp.NebConnection.GetHistoricalAlerts(NebSharp.Types.PageInput,NebSharp.Types.AlertFilter)"> <summary> Retrieves a list of resolved alerts </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <tt>100</tt> items. </param> <param name="filter"> A filter object to filter the open alerts on the server.If omitted, the server will return all objects as a paginated response. </param> <exception cref="T:NebSharp.Core.NebException"> An error with the GraphQL endpoint </exception> <returns>A paginated list of resolved alerts</returns> </member> <member name="M:NebSharp.NebConnection.GetOpenAlerts(NebSharp.Types.PageInput,NebSharp.Types.AlertFilter)"> <summary> Retrieves a list of open alerts </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <tt>100</tt> items. </param> <param name="filter"> A filter object to filter the open alerts on the server.If omitted, the server will return all objects as a paginated response. </param> <exception cref="T:NebSharp.Core.NebException"> An error with the GraphQL endpoint </exception> <returns>A paginated list of open alerts</returns> </member> <member name="M:NebSharp.NebConnection.GetAuditRecords(NebSharp.Types.PageInput,NebSharp.Types.AuditLogFilter)"> <summary> Retrieves a list of audit records </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the audit records on the server. If omitted, the server will return all objects as a paginated response. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.CreateDataCenter(System.String,NebSharp.Types.AddressInput,NebSharp.Types.ContactInput[],System.String)"> <summary> Allows creation of a new datacenter object. <para> A datacenter record allows customers to logically organize their infrastructure by physical location and associate address and contact information with the physical location. This is useful for effective support case handling and reporting purposes. </para> </summary> <param name="name"> Name for the new datacenter </param> <param name="address"> Postal address for the new datacenter </param> <param name="contacts"> List of contacts for the new datacenter. At least one contact must be provided and exactly one contact must have the <c>Primary</c> property set to <c>true</c>. </param> <param name="note"> An optional note for the new datacenter </param> <returns>The new datacenter</returns> <exception cref="T:NebSharp.Core.NebException"> An error with the GraphQL endpoint </exception> </member> <member name="M:NebSharp.NebConnection.DeleteDataCenter(System.Guid,System.Boolean)"> <summary> Allows deletion of an existing datacenter object. <para> The deletion of a datacenter is only possible if the datacenter has no hosts (servers) associated with any child items. By default, deletion of a datacenter is only allowed when the datacenter is not referenced by any rooms or if the <c>cascade</c> parameter is set to <c>true</c>. </para> </summary> <param name="dataCenterGuid"> The unique identifier of the datacenter to delete </param> <param name="cascade"> If set to <c>true</c> any child items of the datacenter (room, row, rack) will automatically deleted with this request. If set to <c>false</c> or omitted and the datacenter has child objects, the deletion will fail with an error. </param> <returns>A bool indicating if the deletion was successful</returns> </member> <member name="M:NebSharp.NebConnection.GetDataCenters(NebSharp.Types.PageInput,NebSharp.Types.DataCenterFilter,NebSharp.Types.DataCenterSort)"> <summary> Retrieves a list of datacenter objects. </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the datacenters on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the datacenter objects on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.UpdateDataCenter(System.Guid,System.String,NebSharp.Types.ContactInput[],NebSharp.Types.AddressInput,System.String)"> <summary> Allows updating properties of an existing datacenter object </summary> <param name="dataCenterGuid"> The unique identifier of the datacenter to update </param> <param name="name"> New name for the datacenter </param> <param name="contacts"> New list of contacts for the new datacenter. At least one contact must be provided and exactly one contact must have the <c>Primary</c> property set to <c>true</c>. </param> <param name="address"> New postal address for the datacenter </param> <param name="note"> A new note for the datacenter. For removing the note, provide an empty str </param> <returns>The updated datacenter</returns> </member> <member name="M:NebSharp.NebConnection.GetHosts(NebSharp.Types.PageInput,NebSharp.Types.HostFilter,NebSharp.Types.HostSort)"> <summary> Retrieves a list of host objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of `100` items. </param> <param name="filter"> A filter object to filter the hosts on the server.If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the host objects on supported properties.If omitted objects are returned in the order as they were created in. </param> <returns>A paginated list of hosts</returns> </member> <member name="M:NebSharp.NebConnection.UpdateHost(System.Guid,NebSharp.Types.UpdateHostInput)"> <summary> Allows updating properties of a host object </summary> <param name="hostGuid"> The unique identifier of the host to update </param> <param name="input"> An input object to update host properties </param> <returns>Updated host</returns> </member> <member name="M:NebSharp.NebConnection.DeleteKeyValue(NebSharp.Types.ResourceType,System.Guid,System.String,System.String)"> <summary> Remove a key value entry from a resource </summary> <param name="resourceType">Type of resource for the key value data</param> <param name="nPodGroupGuid">nPod Group identifier</param> <param name="resourceId">Identifier of the resource for the key value entry</param> <param name="key">Metadata key</param> <returns>Indicator if the query was successful</returns> </member> <member name="M:NebSharp.NebConnection.GetKeyValues(NebSharp.Types.KeyValueFilter)"> <summary> Retrieves a list of key value objects </summary> <param name="filter"> A filter object to filter key value objects on the server.If omitted, the server will return all objects as a paginated response. </param> <returns>A list of key value objects</returns> </member> <member name="M:NebSharp.NebConnection.SetKeyValue(NebSharp.Types.ResourceType,System.Guid,System.String,System.String,System.String)"> <summary> Set a key value entry for a resource. <para> Allows adding metadata to various resources in nebulon ON in the form of key value pairs. This metadata can be used by customers to add arbitrary text information to resources that are not part of the default resource properties. </para> </summary> <param name="resourceType">Type of resource for the key value data</param> <param name="nPodGroupGuid">nPod Group identifier</param> <param name="resourceId">Identifier of the resource for the key value entry</param> <param name="key">Metadata key</param> <param name="value">Metadata value</param> <returns>Indicator if the query was successful</returns> </member> <member name="M:NebSharp.NebConnection.CreateLun(NebSharp.Types.CreateLunInput)"> <summary> Allows creation of a new LUN <para> Allows the creation of a LUN for a volume.A LUN is an instance of a volume export that makes a volume accessible to a host. </para> <para> At least one host must be specified via <c>HostGuids</c> or <c>SpuSerials</c> - either one option must be specified but not both. If the <c>Locak</c> option is provided and set to <c>true</c> then the volume will be exported with ALUA, otherwise with ALUA turned off. </para> </summary> <param name="input"> An input definition for the new LUN. Review the CreateLunInput properties for configuration details </param> <returns>The new LUN if successful</returns> </member> <member name="M:NebSharp.NebConnection.DeleteLun(System.Guid)"> <summary> Allows deletion of a LUN </summary> <param name="lunGuid"> The unique identifier of the LUN to delete </param> <returns>If the deletion was a success</returns> </member> <member name="M:NebSharp.NebConnection.DeleteLuns(System.Guid,System.Guid[],System.Guid[])"> <summary> Allows deletion of multiple LUNs </summary> <param name="volumeGuid"> The unique identifier of the volume from which the LUNs shall be deleted </param> <param name="lunGuids"> The list of LUN identifiers that shall be deleted. If <c>hostGuids</c> is not specified this parameter is mandatory </param> <param name="hostGuids"> The list of host identifiers from which the LUNs shall be deleted. If <c>lunGuids</c> is not specified this parameter is mandatory </param> <returns>If the deletion was a success</returns> </member> <member name="M:NebSharp.NebConnection.GetLuns(NebSharp.Types.PageInput,NebSharp.Types.LunFilter,NebSharp.Types.LunSort)"> <summary> Retrieves a list of LUN objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the LUNs on the server.If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the LUN objects on supported properties.If omitted objects are returned in the order as they were created in. </param> <returns>A paginated list of LUNs</returns> </member> <member name="M:NebSharp.NebConnection.GetMetadata"> <summary> Retrieves a list of metadata information describing UCAPI </summary> <returns>Metadata information that describes UCAPI</returns> </member> <member name="M:NebSharp.NebConnection.CreateNPodGroup(System.String,System.String)"> <summary> Allows creation of a new nPod group object <para> Allows creation of a new nPod group object in nebulon ON. A nPod group allows logical grouping of nPods into security domains. Each nPod group can receive custom security policies. </para> </summary> <param name="name"> The name of the new nPod group </param> <param name="note"> The optional note for the new nPod group. </param> <returns>The new nPod group</returns> </member> <member name="M:NebSharp.NebConnection.DeleteNPodGroup(System.Guid)"> <summary> Allows deleting a nPod group object </summary> <param name="nPodGroupGuid"> The unique identifier of the nPod group to delete </param> <returns>If the deletion was a success</returns> </member> <member name="M:NebSharp.NebConnection.GetNebNPodGroups(NebSharp.Types.PageInput,NebSharp.Types.NPodGroupFilter,NebSharp.Types.NPodGroupSort)"> <summary> Retrieves a list of nPod group objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the items on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the objects on supported properties.If omitted objects are returned in the order as they were created in. </param> <returns>Paginated list of nPod groups</returns> </member> <member name="M:NebSharp.NebConnection.GetNPodGroupCount(NebSharp.Types.NPodGroupFilter)"> <summary> Retrieves the number of nPod groups matching the filter </summary> <param name="filter"> A filter object to filter the items on the server. If omitted, all items are counted on the server </param> <returns>The number of nPod groups matching the filter</returns> </member> <member name="M:NebSharp.NebConnection.UpdateNPodGroup(System.Guid,System.String,System.String)"> <summary> Allows updating new nPod group object properties <para> Allows updating of an existing nPod group object in nebulon ON. A nPod group allows logical grouping of nPods into security domains. Each nPod group can receive custom security policies. </para> </summary> <param name="nPodGroupGuid"> The unique identifier of the nPod group to update </param> <param name="name"> The new name of the nPod group </param> <param name="note"> The new note for the nPod group. For removing the note, provide an empty string. </param> <returns>The updated nPod group</returns> </member> <member name="F:NebSharp.NebConnection.NPOD_CREATE_WAITTIME_SEC"> <summary> Total wait time in seconds until a nPod is created </summary> </member> <member name="M:NebSharp.NebConnection.CreateNPod(System.String,System.Guid,NebSharp.Types.NPodSpuInput[],System.Guid,System.String,System.String,System.Boolean)"> <summary> Allows creation of a new nPod <para> A nPod is a collection of network-connected application servers with SPUs installed that form an application cluster. Together, the SPUs in a nPod serve shared or local storage to the servers in the application cluster, e.g.a hypervisor cluster, container platform, or clustered bare metal application. </para> </summary> <param name="name"> Name of the new nPod </param> <param name="nPodGroupGuid"> The unique identifier of the nPod group this nPod will be added to </param> <param name="nPodSpuInputs"> List of SPU configuration information that will be used in the new nPod </param> <param name="templateGuid"> The unique identifier of the nPod template to use for the new nPod </param> <param name="note"> An optional note for the new nPod </param> <param name="timezone"> The timezone to be configured for all SPUs in the nPod </param> <param name="ignoreWarnings"> If specified and set to <c>true</c> the nPod creation will proceed even if nebulon ON reports warnings. It is advised to not ignore warnings. Consequently, the default behavior is that the nPod creation will fail when nebulon ON reports validation errors. </param> <returns>The new nPod</returns> </member> <member name="M:NebSharp.NebConnection.DeleteNPod(System.Guid,System.Boolean)"> <summary> Delete an existing nPod <para> Deletes an nPod and erases all stored data.During nPod deletion the configuration of SPUs in an nPod is wiped and data encryption keys are erased. This renders all data in the nPod unrecoverable. This operation is irreversible. </para> </summary> <param name="nPodGuid"> The unique identifier of the nPod to delete </param> <param name="secureErase"> Forces a secure wipe of the nPod. While this is not required in most cases as nPod deletion will destroy the encryption keys and render data unreadable, it allows to explicitly overwrite data on server SSDs. Only use this flag when decommissioning storage as the secure_wipe procedure will take some time. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.GetNebNPods(NebSharp.Types.PageInput,NebSharp.Types.NPodFilter,NebSharp.Types.NebNpodSort)"> <summary> Retrieve a list of provisioned nPods </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the nPods on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the nPod objects on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns> A paginated list of nPods </returns> </member> <member name="M:NebSharp.NebConnection.SendNPodDebugInfo(System.Guid,System.String)"> <summary> Allows sending verbose diagnostic information to nebulon ON <para> In cases where more in-depth diagnostic information is required to resolve customer issues, this method allows capturing and uploading verbose diagnostic information from SPUs in the specified nPod through a secure channel to nebulon ON. </para> </summary> <param name="nPodGuid"> The unique identifier of the affected nPod. </param> <param name="note"> Allows specifying additional textual information that is added to the diagnostic bundle.This allows a user to provide accompanying information, e.g.to describe an observed issue. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.SetNPodTimezone(System.Guid,System.String)"> <summary> Allows setting the timezone for all SPUs in an nPod </summary> <param name="nPodGuid"> The unique identifier of the nPod that is being modified </param> <param name="timezone"> The target timezone for the nPod. Refer to the <c>Timezone</c> enumeration for available options. By default <c>UTC</c> is used for the timezone. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.GetNewNPodIssues(NebSharp.Types.NPodSpuInput[])"> <summary> Internal method that checks for issues during nPod creation. </summary> <param name="nPodSpuInputs"></param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.CreateNPodTemplate(NebSharp.Types.CreateNPodTemplateInput)"> <summary> Create a new nPod template </summary> <param name="input"> An input object that describes the new nPod template </param> <returns>The created nPod template</returns> </member> <member name="M:NebSharp.NebConnection.DeleteNPodTemplate(System.Guid)"> <summary> Delete an existing nPod template tree <para> This deletes an nPod template and all associated versions will become unavailable for nPod provisioning if the <c>ParentGuid</c> is supplied, otherwise the specific version is deleted. </para> </summary> <param name="nPodTemplateGuid"> The unique identifier of the nPod template tree. The <c>ParentGuid</c> property of the nPod template should be used for deletion. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.GetNPodTemplates(NebSharp.Types.PageInput,NebSharp.Types.NPodTemplateFilter,NebSharp.Types.NPodTemplateSort)"> <summary> Retrieve a list of provisioned nPod templates </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the nPod templates on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the nPod template objects on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns>A paginated list of nPod templates</returns> </member> <member name="M:NebSharp.NebConnection.UpdateNPodTemplate(NebSharp.Types.UpdateNPodTemplateInput)"> <summary> Update an existing nPod template. <para> Every change to a nPod template will create a new version of the template and generate a new unique identifier (Guid). The parent / original nPod template is accessible via the nPod template <c>ParentGuid</c> property. </para> </summary> <param name="input"> An input object that describes the changes to the nPod template </param> <returns>The created nPod template</returns> </member> <member name="M:NebSharp.NebConnection.GetPhysicalDrives(NebSharp.Types.PageInput,NebSharp.Types.PhysicalDriveFilter,NebSharp.Types.PhysicalDriveSort)"> <summary> Retrieves a list of physical drive objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the physical drives on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the physical drive objects on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.GetPhysicalDriveUpdates(NebSharp.Types.PageInput,NebSharp.Types.PhysicalDriveUpdatesFilter,NebSharp.Types.PhysicalDriveUpdatesSort)"> <summary> Retrieves a list of physical drive update objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the physical drive updates on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the physical drive update objects on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.LocatePhysicalDrive(System.String,System.Int64)"> <summary> Turn on the locate LED of a physical drive </summary> <param name="wwn"> The world-wide name of the physical drive </param> <param name="durationSeconds"> The number of seconds after which the locate LED will automatically be turned off again </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.UpdatePhysicalDriveFirmware(System.Nullable{System.Guid},System.String,System.Boolean)"> <summary> Update the firmware of physical drives. <para> Either <c>nPodGuid</c> or <c>spuSerial</c> must be specified </para> </summary> <param name="nPodGuid"> The nPod unique identifier. </param> <param name="spuSerial"> The SPU serial number </param> <param name="acceptEula"> Specify <c>true</c> if you accept the physical drive end user license agreement. If not specified or set to <c>false</c> the update will fail. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.CreateRack(System.Guid,System.String,System.String,System.String)"> <summary> Allows creation of a new rack object <para> A rack record allows customers to logically organize their infrastructure by physical location. </para> </summary> <param name="rowGuid"> Unique identifier for the parent row </param> <param name="name"> Name for the new rack </param> <param name="note"> An optional note for the new rack </param> <param name="location"> An optional location for the new rack </param> <returns>The new rack</returns> </member> <member name="M:NebSharp.NebConnection.DeleteRack(System.Guid)"> <summary> Allows deletion of an existing rack object <para> The deletion of a rack is only possible if the rack has no hosts (servers) associated. </para> </summary> <param name="rackGuid"> The unique identifier of the datacenter room to delete </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.GetRacks(NebSharp.Types.PageInput,NebSharp.Types.RackFilter,NebSharp.Types.RackSort)"> <summary> Retrieves a list of rack objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of `100` items.</param> <param name="filter"> A filter object to filter the racks on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the racks on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.UpdateRack(System.Guid,System.Nullable{System.Guid},System.String,System.String,System.String)"> <summary> Allows updating properties of an existing rack object <para>At least one property must be specified</para> </summary> <param name="rackGuid"> The unique identifier of the rack to update </param> <param name="rowGuid"> New parent row for the rack </param> <param name="name"> New name for the rack </param> <param name="note"> The new note for the rack. For removing the note, provide an empty str. </param> <param name="location"> A new optional location for the new datacenter room </param> <returns>The updated rack object</returns> </member> <member name="M:NebSharp.NebConnection.CreateRbacPolicy(System.Guid,System.String[])"> <summary> Allows creation of a new RBAC policy </summary> <param name="roleGuid"> The RBAC role unique identifier to associate with the policy </param> <param name="scopes"> List of scope definitions that this policy applies to. At least one scope must be provided. </param> <returns>The new RBAC policy</returns> </member> <member name="M:NebSharp.NebConnection.CreateRbacRole(System.String,System.String,System.String[])"> <summary> Allows creation of a new RBAC role. </summary> <param name="name"> Human readable name for the RBAC role </param> <param name="description"> A description that well describes the role and associated rights. The role description should provide enough clarity so that users should not have to read individual rights </param> <param name="rights"> List of rights definitions. Please review the class description of options for <c>Resource</c> and <c>Permission</c> in the rights string that is in the format <c>{resource}/{permission}</c>. Use the <c>GetMetadata</c> query to retrieve the latest list of options. </param> <returns>The new RBAC role</returns> </member> <member name="M:NebSharp.NebConnection.DeleteRbacPolicy(System.Guid)"> <summary> Allows deletion of an RBAC policy object </summary> <param name="guid"> The unique identifier of the RBAC policy to delete </param> <returns>If the query was successful</returns> </member> <member name="M:NebSharp.NebConnection.DeleteRbacRole(System.Guid)"> <summary> Allows deletion of an RBAC role object </summary> <param name="guid"> The unique identifier of the RBAC role to delete </param> <returns>If the query was successful</returns> </member> <member name="M:NebSharp.NebConnection.GetRbacPolicies(NebSharp.Types.PageInput,NebSharp.Types.RbacPolicyFilter,NebSharp.Types.RbacPolicySort)"> <summary> Retrieves a list of RBAC policy objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items.</param> <param name="filter"> A filter object to filter the RBAC policies on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the RBAC policies on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns>A paginated list of RBAC policies.</returns> </member> <member name="M:NebSharp.NebConnection.GetRbacRoles(NebSharp.Types.PageInput,NebSharp.Types.RbacRoleFilter,NebSharp.Types.RbacRoleSort)"> <summary> Retrieves a list of RBAC role objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of `100` items.</param> <param name="filter"> A filter object to filter the RBAC roles on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the RBAC roles on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns>A paginated list of RBAC roles</returns> </member> <member name="M:NebSharp.NebConnection.UpdateRbacPolicy(System.Guid,System.String[])"> <summary> Allows updating of RBAC policy properties </summary> <param name="guid"> The RBAC policy unique identifier to update </param> <param name="scopes"> List of scope definitions that this policy applies to. At least one scope must be provided. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.UpdateRbacRole(System.Guid,System.String,System.String,System.String[])"> <summary> Allows updating of RBAC role properties </summary> <param name="guid"> The RBAC role unique identifier to update </param> <param name="name"> Human readable name for the RBAC role </param> <param name="description"> A description that well describes the role and associated rights. The role description should provide enough clarity so that users should not have to read individual rights </param> <param name="rights"> List of rights definitions. Please review the class description of options for <c>Resource</c> and <c>Permission</c> in the rights string that is in the format <c>{resource}/{permission}</c>. Use the <c>GetMetadata</c> query to retrieve the latest list of options. </param> <returns>The new RBAC role</returns> </member> <member name="M:NebSharp.NebConnection.GetNPodRecipes(NebSharp.Types.NPodRecipeFilter)"> <summary> Retrieves a list of recipes <para> Recipes are the result of mutations of mutations or modifications of on-premises infrastructure. As commands may require some time to complete, the recipe filter allows the query for their status. </para> </summary> <param name="filter"> A filter object to filter the nPod recipes on the server. If omitted, the server will return all objects as a paginated response. </param> <returns> A paginated list of nPod recipes </returns> </member> <member name="M:NebSharp.NebConnection.CreateRoom(System.Guid,System.String,System.String,System.String)"> <summary> Allows creation of a new datacenter room object <para> A datacenter room record allows customers to logically organize their infrastructure by physical location. </para> </summary> <param name="dataCenterGuid"> Unique identifier for the parent datacenter </param> <param name="name"> Name for the new datacenter room </param> <param name="note"> An optional note for the new datacenter room </param> <param name="location"> An optional location for the new datacenter room </param> <returns>The new datacenter room</returns> </member> <member name="M:NebSharp.NebConnection.DeleteRoom(System.Guid,System.Boolean)"> <summary> Allows deletion of an existing datacenter room object <para> The deletion of a datacenter room is only possible if the room has no hosts (servers) associated with any child items. By default, deletion of a datacenter room is only allowed when it is not referenced by any rows or if the <c>cascade</c> parameter is set to <c>true</c>. </para> </summary> <param name="roomGuid"> The unique identifier of the datacenter room to delete </param> <param name="cascade"> If set to True any child items of the datacenter room (row, rack) will automatically deleted with this request. If set to False or omitted and the datacenter room has child objects, the deletion will fail with an error. </param> </member> <member name="M:NebSharp.NebConnection.GetRooms(NebSharp.Types.PageInput,NebSharp.Types.RoomFilter,NebSharp.Types.RoomSort)"> <summary> Retrieves a list of datacenter room objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of `100` items.</param> <param name="filter"> A filter object to filter the datacenter rooms on the server.If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the datacenter rooms on supported properties.If omitted objects are returned in the order as they were created in. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.UpdateRoom(System.Guid,System.String,System.String,System.String)"> <summary> Allows updating properties of an existing datacenter room object <para>At least one property must be specified</para> </summary> <param name="roomGuid"> The unique identifier of the datacenter room to update </param> <param name="name"> New name for the datacenter room </param> <param name="note"> The new note for the datacenter room. For removing the note, provide an empty str </param> <param name="location"> A new optional location for the new datacenter room </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.CreateRow(System.String,System.Guid,System.String,System.String)"> <summary> Allows creation of a new datacenter room object <para> Allows the creation of a row object in nebulon ON. A row record allows customers to logically organize their infrastructure by physical location. </para> </summary> <param name="name"> Name for the new row </param> <param name="roomGuid"> Unique identifier for the parent room </param> <param name="note"> An optional note for the new row </param> <param name="location"> An optional location for the new row </param> <returns>The new row in a datacenter</returns> </member> <member name="M:NebSharp.NebConnection.DeleteRow(System.Guid,System.Boolean)"> <summary> Allows deletion of an existing row object <para> The deletion of a row is only possible if the row has no hosts (servers) associated with any child items. By default, deletion of a row is only allowed when it is not referenced by any racks or if the <c>cascade</c> parameter is set to <c>true</c>. </para> </summary> <param name="guid"> The unique identifier of the row to delete </param> <param name="cascade"> If set to <c>true</c> any child items of the row (rack) will automatically deleted with this request. If set to <c>false</c> or omitted and the row has child objects, the deletion will fail with an error. </param> <returns>If the query was successful</returns> </member> <member name="M:NebSharp.NebConnection.GetRows(NebSharp.Types.PageInput,NebSharp.Types.RowFilter,NebSharp.Types.RowSort)"> <summary> Retrieves a list of row objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the row on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the row on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns>A paginated list of rows in a datacenter</returns> </member> <member name="M:NebSharp.NebConnection.Update(System.Guid,System.String,System.Nullable{System.Guid},System.String,System.String)"> <summary> Allows updating properties of an existing datacenter room object. <para> At least one property must be specified. </para> </summary> <param name="guid"> The unique identifier of the row to update </param> <param name="name"> New name for the row </param> <param name="roomGuid"> New parent room for the row </param> <param name="note"> The new note for the row. For removing the note, provide an empty str. </param> <param name="location"> A new optional location for the row </param> <returns>The updated datacenter row object</returns> </member> <member name="M:NebSharp.NebConnection.GetSessionState"> <summary> Allows querying for the current login state </summary> <returns>Session state</returns> </member> <member name="M:NebSharp.NebConnection.Login(System.String,System.String)"> <summary> Login to nebulon ON </summary> <param name="username">User name</param> <param name="password">Password</param> <returns>Login request result</returns> </member> <member name="M:NebSharp.NebConnection.Logout"> <summary> Logout from nebulon ON <returns>If the logout request was successful</returns> </summary> </member> <member name="F:NebSharp.NebConnection.SNAPSHOT_CREATE_WAITTIME_SEC"> <summary> Total wait time in seconds until a snapshot is created </summary> </member> <member name="M:NebSharp.NebConnection.CreateClone(System.String,System.Guid)"> <summary> Allows creating a read/writeable clone of a volume or snapshot <para> Allows the creation of a volume clone from a base volume or snapshot. Clones are read and writeable copies of another volume. Clones can be used to quickly instantiate copies of data and data for recovery purposes when applications require read/write access for copy operations. </para> </summary> <param name="name"> The human readable name for the volume clone </param> <param name="volumeGuid"> The unique identifier for the volume or snapshot from which to create the clone. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.CreateSnapshot(System.Guid[],System.String[],System.Nullable{System.Int64},System.Nullable{System.Int64})"> <summary> Allows creation of an on-demand snapshot of volumes <para> If multiple volumes are provided, multiple name patterns are required, where the index of the list of items are related. For example, the name pattern at index <c>3</c> of the <c>namePatterns</c> parameter will be applied to the volume specified at index <c>3</c> of the <c>parentVolumeGuids</c> list. </para> </summary> <param name="parentVolumeGuids"> List of unique identifiers for all volumes for which to create a snapshot </param> <param name="namePatterns"> List of naming patterns for volume snapshots. Options of the <c>strftime</c> function are available to format time and the variable <c>%v</c> that will be translated to the volume name. </param> <param name="expirationSeconds"> The number of seconds after snapshot creation when the snapshots will be automatically deleted </param> <param name="retentionSeconds"> The number of seconds before a user can delete the snapshots. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.CreateSnapshotScheduleTemplate(System.String,System.String,NebSharp.Types.ScheduleInput,System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean})"> <summary> Allows creation of a new snapshot schedule template <para> Allows the creation of snapshot schedule templates. Snapshot schedule templates are used to consistently provision snapshot schedules across nPods. They are referenced in nPod templates and are provisioned when a nPod is formed from such a template. </para> </summary> <param name="name"> Human readable name for the snapshot schedule template </param> <param name="namePattern"> A naming pattern for volume snapshot names when they are automatically created. Available variables for the format string are from the standard <c>strftime</c> function. Additionally <c>%v</c> is used for the base volume name. </param> <param name="schedule"> The schedule by which volume snapshots will be created </param> <param name="expirationSeconds"> A time in seconds when snapshots will be automatically deleted. If not specified, snapshots will not be deleted automatically (not recommended) </param> <param name="retentionSeconds"> A time in seconds that prevents users from deleting snapshots. If not specified, snapshots can be immediately deleted. </param> <param name="ignoreBootVolumes"> Allows specifying if boot volumes shall be included when doing snapshots (<c>true</c>) or if they shall be ignored (<c>false</c>). By default, all volumes are included. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.DeleteSnapshotScheduleTemplate(System.Guid)"> <summary> Allows deletion of an existing snapshot schedule template </summary> <param name="guid"> The unique identifier of the snapshot schedule template to delete </param> <returns>If the query was successful</returns> </member> <member name="M:NebSharp.NebConnection.GetSnapshotSchedules(System.Guid)"> <summary> Retrieves a list of provisioned snapshot schedules on an nPod </summary> <param name="nPodGuid"> The unique identifier of the nPod from which the snapshot schedules shall be retrieved. </param> <returns>A list of snapshot schedules</returns> </member> <member name="M:NebSharp.NebConnection.GetSnapshotScheduleTemplates(NebSharp.Types.PageInput,NebSharp.Types.SnapshotScheduleTemplateFilter,NebSharp.Types.SnapshotScheduleTemplateSort)"> <summary> Retrieves a list of snapshot schedule template objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the snapshot schedule template objects on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the snapshot schedule template objects on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.UpdateSnapshotScheduleTemplate(System.Guid,System.String,System.String,NebSharp.Types.ScheduleInput,System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean})"> <summary> Allows updating the properties of a snapshot schedule template <para> Allows updating of snapshot schedule template properties. Snapshot schedule templates are used to consistently provision snapshot schedules across nPods. They are referenced in nPod templates and are provisioned when a nPod is formed from such a template. </para> </summary> <param name="guid"> The unique identifier of the snapshot schedule template to update </param> <param name="name"> Human readable name for the snapshot schedule template </param> <param name="namePattern"> A naming pattern for volume snapshot names when they are automatically created. Available variables for the format string are from the standard <c>strftime</c> function. Additionally <c>%v</c> is used for the base volume name. </param> <param name="schedule"> The schedule by which volume snapshots will be created </param> <param name="expirationSeconds"> A time in seconds when snapshots will be automatically deleted. If not specified, snapshots will not be deleted automatically (not recommended) </param> <param name="retentionSeconds"> A time in seconds that prevents users from deleting snapshots. If not specified, snapshots can be immediately deleted. </param> <param name="ignoreBootVolumes"> Allows specifying if boot volumes shall be included when doing snapshots (<c>true</c>) or if they shall be ignored (<c>false</c>). By default, all volumes are included. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.ClaimSpu(System.String)"> <summary> Adds an unregistered SPU to the organization <para> SPUs need to be claimed by an organization before they can be used for nPod creation.While the nPod creation command will perform an implicit claim, this method allows registering SPUs with an organization without creating an nPod. </para> <para> Once an SPU was claimed, it will become visible in the <c>GetSpus</c> query and in the nebulon ON web user interface. </para> </summary> <param name="spuSerial"> The serial number of the SPU to register with an organization. </param> <returns>If the claim process was successful</returns> </member> <member name="M:NebSharp.NebConnection.DeleteSpuInformation(System.String)"> <summary> Allows deletion of SPU information in nebulon ON </summary> <param name="spuSerial"> The serial number of the SPU </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.GetSpuCustomDiagnostics(System.String)"> <summary> Retrieves a list of custom diagnostic command requests <para> Custom diagnostic command requests are used by customer satisfaction teams to run arbitrary troubleshooting commands on SPUs. These require user confirmation. </para> </summary> <param name="spuSerial"> The serial number for which to query for custom diagnostic command requests </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.GetSpus(NebSharp.Types.PageInput,NebSharp.Types.SpuFilter,NebSharp.Types.SpuSort)"> <summary> Retrieves a list of SPUs </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the SPUs on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the SPU objects on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.LocateSpu(System.String)"> <summary> Turns on the locate LED pattern of the SPU <para> Allows identification of an SPU in the servers by turning on the locate LED pattern for the SPU. Please consult the Cloud-Defined Storage manual for the LED blink patterns. </para> </summary> <param name="spuSerial"> The serial number of the SPU </param> <returns>If the process was successful</returns> </member> <member name="M:NebSharp.NebConnection.ReleaseSpu(System.String)"> <summary> Removes an SPU from an organization </summary> <param name="spuSerial"> The serial number of the SPU </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.ReplaceSpu(System.Guid,System.String,NebSharp.Types.NPodSpuInput,System.Guid)"> <summary> Allows replacing an SPU <para> The replace services processing unit (SPU) operation is used to transition the configuration of an old, likely failed, SPU to a new replacement unit and allows modifying the configuration during the process. </para> </summary> <param name="nPodGuid"> The unique identifier of the nPod of the old SPU that is being replaced </param> <param name="previousSpuSerial"> The serial number of the old SPU that is being replaced </param> <param name="newSpuInfo"> Configuration information for the new SPU </param> <param name="sSetGuid"> The storage set information for the existing SPU. This information can be obtained from the active replacement alert and only used to verify that the correct SPU is selected. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.RunCustomDiagnostics(System.String,System.Nullable{System.Guid},System.String,System.Nullable{System.Guid})"> <summary> Allows running custom diagnostic commands <para> SPU custom diagnostics requests allows customers to run arbitrary diagnostic commands on the services processing units as part of troubleshooting issues during a support case. </para> </summary> <param name="spuSerial"> The serial number of the SPU on which to run diagnostic </param> <param name="npodGuid"> The unique identifier of the nPod on which to run diagnostic </param> <param name="diagnosticName"> The name of the diagnostic to run </param> <param name="requestGuid"> The unique identifier of the custom diagnostic request to run </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.SecureEraseSpu(System.String)"> <summary> Allows to secure-erase data on a services processing unit (SPU) <para> The secure erase functionality allows a deep-erase of data stored on the physical drives attached to the SPU.Only SPUs that are not part of a nPod can be secure-erased. </para> </summary> <param name="spuSerial"> The serial number of the SPU to secure-erase </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.SendSpuDebugInfo(System.String,System.String)"> <summary> Allows submitting additional debugging information to nebulon ON <para> Used for customers to send additional debug information to nebulon ON for troubleshooting and resolve issues. </para> </summary> <param name="spuSerial"> The serial number of the SPU </param> <param name="note"> An optional note to attach to the debug information </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.SetSpuProxy(System.String,System.String)"> <summary> Allows configuring a proxy server for an SPU </summary> <param name="spuSerial"> The serial number of the SPU </param> <param name="proxy"> The proxy server IP address </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.CreateSupportCase(NebSharp.Types.CreateSupportCaseInput)"> <summary> Allows creation of a new support case </summary> <param name="supportCase"> A support case input object </param> <returns>The created support case</returns> </member> <member name="M:NebSharp.NebConnection.GetSupportCases(NebSharp.Types.PageInput,NebSharp.Types.SupportCaseFilter,NebSharp.Types.SupportCaseSort)"> <summary> Retrieves a list of support cases </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of `100` items. </param> <param name="filter"> A filter object to filter support cases on the server.If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort support case objects on supported properties.If omitted objects are returned in the order as they were created in. </param> <returns>A paginated list of support cases</returns> </member> <member name="M:NebSharp.NebConnection.UpdateSupportCase(System.String,NebSharp.Types.CreateSupportCaseInput)"> <summary> Allows updating an existing support case </summary> <param name="number"> The case number of the support case to update </param> <param name="supportCase"> An input object that describes all fields to update </param> <returns>The updated support case</returns> </member> <member name="M:NebSharp.NebConnection.UploadSupportCaseAttachment(System.String,System.String)"> <summary> Allows uploading and attaching files to a support case </summary> <param name="number"> The case number of the support case to update </param> <param name="filePath"> The absolute path to the file to upload </param> <returns>The updated support case</returns> </member> <member name="M:NebSharp.NebConnection.AbortFirmwareUpdate(System.String,System.Nullable{System.Guid})"> <summary> Abort an ongoing firmware update <para> Either <c>spuSerial</c> or <c>nPodGuid</c> must be specified. </para> </summary> <param name="spuSerial"> The serial number of the SPU </param> <param name="nPodGuid"> The unique identifier of the nPod </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.GetUpdatePackages"> <summary> Retrieves a list of update packages </summary> <returns> An object describing latest, available, and recommended nebOS software packages </returns> </member> <member name="M:NebSharp.NebConnection.GetUpdateState(System.Nullable{System.Guid},System.Nullable{System.Guid})"> <summary> Retrieves a list of active updates <para> Allows querying for currently ongoing updates and their status information. </para> </summary> <param name="nPodGuid"> Filter active updates for a specific nPod by providing its unique identifier </param> <param name="updateGuid"> The unique identifier of an ongoing update </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.UpdateNPodFirmware(System.Guid,System.String,System.Nullable{System.DateTime},System.Boolean)"> <summary> Update nPod firmware to specified package </summary> <param name="nPodGuid"> The unique identifier of the nPod to update </param> <param name="packageName"> The package name to install </param> <param name="scheduleAt"> Allows scheduling the installation of a package at the specified date and time. If omitted, the package will be installed immediately </param> <param name="ignoreWarnings"> If specified warnings that are discovered during the update pre-check are ignored (not recommended). If omitted or set to <c>false</c> will cause the update to stop. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.UpdateSpuFirmware(System.String,System.String,System.Boolean)"> <summary> Update nebOS of an SPU to a specific package </summary> <param name="spuSerial"> The serial number of the SPU to update </param> <param name="packageName"> The name of the update package to install </param> <param name="force"> If set to <c>true</c> the update will bypass any safeguards </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.RunUpdatePreCheck(System.Guid,System.String)"> <summary> Runs diagnostics before an update is installed <para> Ensures that an nPod is in a healthy state and that there are no issues preventing a successful update. </para> </summary> <param name="nPodGuid"> The unique identifier of the nPod for which the update pre-check is performed </param> <param name="packageName"> The package name to be installed </param> <returns> A list of warnings and errors discovered during the pre-check </returns> </member> <member name="M:NebSharp.NebConnection.CreateUserGroup(System.String,System.Guid[],System.String)"> <summary> Allows creating a new user group in nebulon ON </summary> <param name="name"> The name of the user group </param> <param name="policyGuids"> List of RBAC policies that shall be assigned to the user group </param> <param name="note"> An optional note for the user </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.DeleteNebUserGroup(System.Guid)"> <summary> Allows deletion of a user group </summary> <param name="guid"> The unique identifier of the user group that should be deleted </param> <returns>If the query was successful</returns> </member> <member name="M:NebSharp.NebConnection.GetNebUserGroupCount(NebSharp.Types.UserGroupFilter)"> <summary> Get the number of user groups that match the specified filter </summary> <param name="filter"> A filter object to filter the user group objects on the server. If omitted, the server will count all objects. </param> <returns>The number of user groups matching the filter</returns> </member> <member name="M:NebSharp.NebConnection.GetUserGroups(NebSharp.Types.PageInput,NebSharp.Types.UserGroupFilter,NebSharp.Types.UserGroupSort)"> <summary> Retrieves a list of user group objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the user group objects on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the user group objects on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.UpdateUserGroup(System.Guid,System.String,System.Guid[],System.String)"> <summary> Allow updating properties of an existing user group </summary> <param name="guid"> The unique identifier of the user group to update </param> <param name="name"> New name for the user group </param> <param name="policyGuids"> List of RBAC policies that shall be assigned to the user group </param> <param name="note"> An optional note for the user </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.CreateUser(NebSharp.Types.CreateUserInput)"> <summary> Allows creating a new user in nebulon ON </summary> <param name="input"> The configuration for the new user </param> <returns>The new user</returns> </member> <member name="M:NebSharp.NebConnection.DeleteUser(System.Guid)"> <summary> Allows deletion of a user account </summary> <param name="guid"> The unique identifier of the user that should be deleted </param> <returns>If the query was successful</returns> </member> <member name="M:NebSharp.NebConnection.GetUserCount(NebSharp.Types.UserFilter)"> <summary> Get the number of users that match the specified filter </summary> <param name="filter"> A filter object to filter the user objects on the server. If omitted, the server will count all objects. </param> <returns></returns> </member> <member name="M:NebSharp.NebConnection.GetUsers(NebSharp.Types.PageInput,NebSharp.Types.UserFilter,NebSharp.Types.UserSort)"> <summary> Retrieves a list of user objects </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the user objects on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the user objects on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns>A paginated list of users</returns> </member> <member name="M:NebSharp.NebConnection.UpdateUser(System.Guid,NebSharp.Types.UpdateUserInput)"> <summary> Allow updating properties of an existing user </summary> <param name="guid"> The unique identifier of the user that should be updated </param> <param name="input"> The updates for the user </param> <returns></returns> </member> <member name="F:NebSharp.NebConnection.VOLUME_CREATE_WAITTIME_SEC"> <summary> Total wait time in seconds until a snapshot is created </summary> </member> <member name="M:NebSharp.NebConnection.CreateVolume(NebSharp.Types.CreateVolumeInput)"> <summary> Allows creation of a new volume </summary> <param name="input"> Configuration definition for the new volume </param> <returns>The created volume</returns> </member> <member name="M:NebSharp.NebConnection.DeleteVolume(System.Guid)"> <summary> Allows deletion of a volume </summary> <param name="guid"> The unique identifier of the volume or snapshot to delete </param> <returns>If the request was successful</returns> </member> <member name="M:NebSharp.NebConnection.GetVolumes(NebSharp.Types.PageInput,NebSharp.Types.VolumeFilter,NebSharp.Types.VolumeSort)"> <summary> Returns a list of configured <b>NebVolume</b> instances based on the provided page and filter information. </summary> <param name="page"> The requested page from the server. This is an optional argument and if omitted the server will default to returning the first page with a maximum of <c>100</c> items. </param> <param name="filter"> A filter object to filter the volumes on the server. If omitted, the server will return all objects as a paginated response. </param> <param name="sort"> A sort definition object to sort the volume objects on supported properties. If omitted objects are returned in the order as they were created in. </param> <returns>A paginated list of volumes</returns> </member> </members> </doc> |