VolumePatch interface
Volume patch resource
Properties
cool |
Specifies whether Cool Access(tiering) is enabled for the volume. |
cool |
coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage. |
coolness |
Specifies the number of days after which data that is not accessed by clients will be tiered. |
data |
DataProtection type volumes include an object containing details of the replication |
default |
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. |
default |
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . |
export |
Set of export policy rules |
id | Resource Id NOTE: This property will not be serialized. It can only be populated by the server. |
is |
Specifies if default quota is enabled for the volume. |
location | Resource location |
name | Resource name NOTE: This property will not be serialized. It can only be populated by the server. |
protocol |
Set of protocol types, default NFSv3, CIFS for SMB protocol |
service |
The service level of the file system |
smb |
Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume |
smb |
Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume |
snapshot |
If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots. |
tags | Resource tags |
throughput |
Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume |
type | Resource type NOTE: This property will not be serialized. It can only be populated by the server. |
unix |
UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. |
usage |
Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. |
Property Details
coolAccess
Specifies whether Cool Access(tiering) is enabled for the volume.
coolAccess?: boolean
Property Value
boolean
coolAccessRetrievalPolicy
coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage.
coolAccessRetrievalPolicy?: string
Property Value
string
coolnessPeriod
Specifies the number of days after which data that is not accessed by clients will be tiered.
coolnessPeriod?: number
Property Value
number
dataProtection
DataProtection type volumes include an object containing details of the replication
dataProtection?: VolumePatchPropertiesDataProtection
Property Value
defaultGroupQuotaInKiBs
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
defaultGroupQuotaInKiBs?: number
Property Value
number
defaultUserQuotaInKiBs
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
defaultUserQuotaInKiBs?: number
Property Value
number
exportPolicy
Set of export policy rules
exportPolicy?: VolumePatchPropertiesExportPolicy
Property Value
id
Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
isDefaultQuotaEnabled
Specifies if default quota is enabled for the volume.
isDefaultQuotaEnabled?: boolean
Property Value
boolean
location
Resource location
location?: string
Property Value
string
name
Resource name NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
protocolTypes
Set of protocol types, default NFSv3, CIFS for SMB protocol
protocolTypes?: string[]
Property Value
string[]
serviceLevel
The service level of the file system
serviceLevel?: string
Property Value
string
smbAccessBasedEnumeration
Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
smbAccessBasedEnumeration?: string
Property Value
string
smbNonBrowsable
Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
smbNonBrowsable?: string
Property Value
string
snapshotDirectoryVisible
If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots.
snapshotDirectoryVisible?: boolean
Property Value
boolean
tags
Resource tags
tags?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
throughputMibps
Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume
throughputMibps?: number
Property Value
number
type
Resource type NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
unixPermissions
UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.
unixPermissions?: string
Property Value
string
usageThreshold
Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.
usageThreshold?: number
Property Value
number