Package-level declarations

Types

Link copied to clipboard
data class AccountEncryptionResponse(val keySource: String? = null)

Encryption settings

Link copied to clipboard
data class ActiveDirectoryResponse(val activeDirectoryId: String? = null, val adName: String? = null, val aesEncryption: Boolean? = null, val allowLocalNfsUsersWithLdap: Boolean? = null, val backupOperators: List<String>? = null, val dns: String? = null, val domain: String? = null, val kdcIP: String? = null, val ldapOverTLS: Boolean? = null, val ldapSigning: Boolean? = null, val organizationalUnit: String? = null, val password: String? = null, val securityOperators: List<String>? = null, val serverRootCACertificate: String? = null, val site: String? = null, val smbServerName: String? = null, val status: String, val statusDetails: String, val username: String? = null)

Active Directory

Link copied to clipboard
data class DailyScheduleResponse(val hour: Int? = null, val minute: Int? = null, val snapshotsToKeep: Int? = null, val usedBytes: Double? = null)

Daily Schedule properties

Link copied to clipboard
data class ExportPolicyRuleResponse(val allowedClients: String? = null, val chownMode: String? = null, val cifs: Boolean? = null, val hasRootAccess: Boolean? = null, val kerberos5ReadOnly: Boolean? = null, val kerberos5ReadWrite: Boolean? = null, val kerberos5iReadOnly: Boolean? = null, val kerberos5iReadWrite: Boolean? = null, val kerberos5pReadOnly: Boolean? = null, val kerberos5pReadWrite: Boolean? = null, val nfsv3: Boolean? = null, val nfsv41: Boolean? = null, val ruleIndex: Int? = null, val unixReadOnly: Boolean? = null, val unixReadWrite: Boolean? = null)

Volume Export Policy Rule

Link copied to clipboard
data class GetAccountResult(val activeDirectories: List<ActiveDirectoryResponse>? = null, val encryption: AccountEncryptionResponse? = null, val id: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

NetApp account resource

Link copied to clipboard
data class GetBackupPolicyResult(val dailyBackupsToKeep: Int? = null, val enabled: Boolean? = null, val id: String, val location: String, val monthlyBackupsToKeep: Int? = null, val name: String, val provisioningState: String, val tags: Map<String, String>? = null, val type: String, val volumeBackups: List<VolumeBackupsResponse>? = null, val volumesAssigned: Int? = null, val weeklyBackupsToKeep: Int? = null, val yearlyBackupsToKeep: Int? = null)

Backup policy information

Link copied to clipboard
data class GetBackupResult(val backupId: String, val backupType: String, val creationDate: String, val failureReason: String, val id: String, val label: String? = null, val location: String, val name: String, val provisioningState: String, val size: Double, val type: String, val volumeName: String)

Backup of a Volume

Link copied to clipboard
data class GetPoolResult(val id: String, val location: String, val name: String, val poolId: String, val provisioningState: String, val qosType: String? = null, val serviceLevel: String, val size: Double, val tags: Map<String, String>? = null, val totalThroughputMibps: Double, val type: String, val utilizedThroughputMibps: Double)

Capacity pool resource

Link copied to clipboard
data class GetSnapshotPolicyResult(val dailySchedule: DailyScheduleResponse? = null, val enabled: Boolean? = null, val hourlySchedule: HourlyScheduleResponse? = null, val id: String, val location: String, val monthlySchedule: MonthlyScheduleResponse? = null, val name: String, val provisioningState: String, val tags: Map<String, String>? = null, val type: String, val weeklySchedule: WeeklyScheduleResponse? = null)

Snapshot policy information

Link copied to clipboard
data class GetSnapshotResult(val created: String, val id: String, val location: String, val name: String, val provisioningState: String, val snapshotId: String, val type: String)

Snapshot of a Volume

Link copied to clipboard
data class GetSubvolumeMetadataResult(val accessedTimeStamp: String? = null, val bytesUsed: Double? = null, val changedTimeStamp: String? = null, val creationTimeStamp: String? = null, val id: String, val modifiedTimeStamp: String? = null, val name: String, val parentPath: String? = null, val path: String? = null, val permissions: String? = null, val provisioningState: String? = null, val size: Double? = null, val type: String)

Result of the post subvolume and action is to get metadata of the subvolume.

Link copied to clipboard
data class GetSubvolumeResult(val id: String, val name: String, val parentPath: String? = null, val path: String? = null, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

Subvolume Information properties

Link copied to clipboard
data class GetVolumeGroupResult(val groupMetaData: VolumeGroupMetaDataResponse? = null, val id: String, val location: String? = null, val name: String, val provisioningState: String, val tags: Map<String, String>? = null, val type: String, val volumes: List<VolumeGroupVolumePropertiesResponse>? = null)

Volume group resource for create

Link copied to clipboard
data class GetVolumeQuotaRuleResult(val id: String, val location: String, val name: String, val provisioningState: String, val quotaSizeInKiBs: Double? = null, val quotaTarget: String? = null, val quotaType: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Quota Rule of a Volume

Link copied to clipboard
data class GetVolumeResult(val backupId: String? = null, val baremetalTenantId: String, val creationToken: String, val dataProtection: VolumePropertiesResponseDataProtection? = null, val encryptionKeySource: String? = null, val exportPolicy: VolumePropertiesResponseExportPolicy? = null, val fileSystemId: String, val id: String, val isRestoring: Boolean? = null, val kerberosEnabled: Boolean? = null, val ldapEnabled: Boolean? = null, val location: String, val mountTargets: List<MountTargetPropertiesResponse>, val name: String, val protocolTypes: List<String>? = null, val provisioningState: String, val securityStyle: String? = null, val serviceLevel: String? = null, val smbContinuouslyAvailable: Boolean? = null, val smbEncryption: Boolean? = null, val snapshotDirectoryVisible: Boolean? = null, val snapshotId: String? = null, val subnetId: String, val tags: Map<String, String>? = null, val throughputMibps: Double? = null, val type: String, val usageThreshold: Double, val volumeType: String? = null)

Volume resource

Link copied to clipboard
data class HourlyScheduleResponse(val minute: Int? = null, val snapshotsToKeep: Int? = null, val usedBytes: Double? = null)

Hourly Schedule properties

Link copied to clipboard
data class ListVolumeReplicationsResult(val value: List<ReplicationResponse>? = null)

List Replications

Link copied to clipboard
data class MonthlyScheduleResponse(val daysOfMonth: String? = null, val hour: Int? = null, val minute: Int? = null, val snapshotsToKeep: Int? = null, val usedBytes: Double? = null)

Monthly Schedule properties

Link copied to clipboard
data class MountTargetPropertiesResponse(val fileSystemId: String, val ipAddress: String, val mountTargetId: String, val smbServerFqdn: String? = null)

Mount target properties

Link copied to clipboard
data class PlacementKeyValuePairsResponse(val key: String, val value: String)

Application specific parameters for the placement of volumes in the volume group

Link copied to clipboard
data class ReplicationObjectResponse(val endpointType: String? = null, val remoteVolumeRegion: String? = null, val remoteVolumeResourceId: String, val replicationId: String? = null, val replicationSchedule: String? = null)

Replication properties

Link copied to clipboard
data class ReplicationResponse(val endpointType: String? = null, val remoteVolumeRegion: String? = null, val remoteVolumeResourceId: String, val replicationSchedule: String? = null)

Replication properties

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class VolumeBackupPropertiesResponse(val backupEnabled: Boolean? = null, val backupPolicyId: String? = null, val policyEnforced: Boolean? = null, val vaultId: String? = null)

Volume Backup Properties

Link copied to clipboard
data class VolumeBackupsResponse(val backupsCount: Int? = null, val policyEnabled: Boolean? = null, val volumeName: String? = null)

Volume details using the backup policy

Link copied to clipboard
data class VolumeGroupMetaDataResponse(val applicationIdentifier: String? = null, val applicationType: String? = null, val deploymentSpecId: String? = null, val globalPlacementRules: List<PlacementKeyValuePairsResponse>? = null, val groupDescription: String? = null, val volumesCount: Double)

Volume group properties

Link copied to clipboard
data class VolumeGroupVolumePropertiesResponse(val avsDataStore: String? = null, val backupId: String? = null, val baremetalTenantId: String, val capacityPoolResourceId: String? = null, val cloneProgress: Int, val coolAccess: Boolean? = null, val coolnessPeriod: Int? = null, val creationToken: String, val dataProtection: VolumePropertiesResponseDataProtection? = null, val defaultGroupQuotaInKiBs: Double? = null, val defaultUserQuotaInKiBs: Double? = null, val enableSubvolumes: String? = null, val encryptionKeySource: String? = null, val exportPolicy: VolumePropertiesResponseExportPolicy? = null, val fileSystemId: String, val id: String, val isDefaultQuotaEnabled: Boolean? = null, val isRestoring: Boolean? = null, val kerberosEnabled: Boolean? = null, val ldapEnabled: Boolean? = null, val maximumNumberOfFiles: Double, val mountTargets: List<MountTargetPropertiesResponse>, val name: String? = null, val networkFeatures: String? = null, val networkSiblingSetId: String, val placementRules: List<PlacementKeyValuePairsResponse>? = null, val protocolTypes: List<String>? = null, val provisioningState: String, val proximityPlacementGroup: String? = null, val securityStyle: String? = null, val serviceLevel: String? = null, val smbContinuouslyAvailable: Boolean? = null, val smbEncryption: Boolean? = null, val snapshotDirectoryVisible: Boolean? = null, val snapshotId: String? = null, val storageToNetworkProximity: String, val subnetId: String, val t2Network: String, val tags: Map<String, String>? = null, val throughputMibps: Double? = null, val type: String, val unixPermissions: String? = null, val usageThreshold: Double, val volumeGroupName: String, val volumeSpecName: String? = null, val volumeType: String? = null)

Volume resource

Link copied to clipboard
data class VolumePropertiesResponseDataProtection(val backup: VolumeBackupPropertiesResponse? = null, val replication: ReplicationObjectResponse? = null, val snapshot: VolumeSnapshotPropertiesResponse? = null)

DataProtection type volumes include an object containing details of the replication

Link copied to clipboard

Set of export policy rules

Link copied to clipboard
data class VolumeSnapshotPropertiesResponse(val snapshotPolicyId: String? = null)

Volume Snapshot Properties

Link copied to clipboard
data class WeeklyScheduleResponse(val day: String? = null, val hour: Int? = null, val minute: Int? = null, val snapshotsToKeep: Int? = null, val usedBytes: Double? = null)

Weekly Schedule properties, make a snapshot every week at a specific day or days