iscsi.extent.create

Create an iSCSI Extent.

When type is set to FILE, attribute filesize is used and it represents number of bytes. filesize if not zero should be a multiple of blocksize. path is a required attribute with type set as FILE.

With type being set to DISK, a valid ZFS volume is required.

insecure_tpc when enabled allows an initiator to bypass normal access control and access any scannable target. This allows xcopy operations otherwise blocked by access control.

xen is a boolean value which is set to true if Xen is being used as the iSCSI initiator.

ro when set to true prevents the initiator from writing to this LUN.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: iscsi_extent_create

iscsi_extent_create

Type: object

iSCSI extent configuration data for creation.

No Additional Properties

name Required

Name

Type: string

Name of the iSCSI extent.

Must be at least 1 characters long

Must be at most 64 characters long

type

Type

Type: enum (of string) Default: "DISK"

Type of the extent storage backend.

Must be one of:

• "DISK"
• "FILE"

disk

Disk

Default: null

Disk device to use for the extent or null if using a file.

Any of

• Option 1
• Option 2

Type: string

Type: null

serial

Serial

Default: null

Serial number for the extent or null to auto-generate.

Any of

• Option 1
• Option 2

Type: string

Type: null

path

Path

Default: null

File path for file-based extents or null if using a disk.

Any of

• Option 1
• Option 2

Type: string

Type: null

filesize

Filesize

Default: "0"

Size of the file-based extent in bytes.

Any of

• Option 1
• Option 2

Type: string

Type: integer

blocksize

Blocksize

Type: enum (of integer) Default: 512

Block size for the extent in bytes.

Must be one of:

• 512
• 1024
• 2048
• 4096

pblocksize

Pblocksize

Type: boolean Default: false

Whether to use physical block size reporting.

avail_threshold

Avail Threshold

Default: null

Available space threshold percentage or null to disable.

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 1 and lesser or equal to 99

Type: null

comment

Comment

Type: string Default: ""

Optional comment describing the extent.

insecure_tpc

Insecure Tpc

Type: boolean Default: true

Whether to enable insecure Third Party Copy (TPC) operations.

xen

Xen

Type: boolean Default: false

Whether to enable Xen compatibility mode.

rpm

Rpm

Type: enum (of string) Default: "SSD"

Reported RPM type for the extent.

Must be one of:

• "UNKNOWN"
• "SSD"
• "5400"
• "7200"
• "10000"
• "15000"

ro

Ro

Type: boolean Default: false

Whether the extent is read-only.

enabled

Enabled

Type: boolean Default: true

Whether the extent is enabled and available for use.

product_id

Product Id

Default: null

Product ID string for the extent or null for default.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Must be at most 16 characters long

Type: null

Return value

IscsiExtentEntry

Type: object

The created iSCSI extent configuration.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for the iSCSI extent.

name Required

Name

Type: string

Name of the iSCSI extent.

Must be at least 1 characters long

Must be at most 64 characters long

type

Type

Type: enum (of string) Default: "DISK"

Type of the extent storage backend.

Must be one of:

• "DISK"
• "FILE"

disk

Disk

Default: null

Disk device to use for the extent or null if using a file.

Any of

• Option 1
• Option 2

Type: string

Type: null

serial

Serial

Default: null

Serial number for the extent or null to auto-generate.

Any of

• Option 1
• Option 2

Type: string

Type: null

path

Path

Default: null

File path for file-based extents or null if using a disk.

Any of

• Option 1
• Option 2

Type: string

Type: null

filesize

Filesize

Default: "0"

Size of the file-based extent in bytes.

Any of

• Option 1
• Option 2

Type: string

Type: integer

blocksize

Blocksize

Type: enum (of integer) Default: 512

Block size for the extent in bytes.

Must be one of:

• 512
• 1024
• 2048
• 4096

pblocksize

Pblocksize

Type: boolean Default: false

Whether to use physical block size reporting.

avail_threshold

Avail Threshold

Default: null

Available space threshold percentage or null to disable.

Any of

• Option 1
• Option 2

Type: integer

Value must be greater or equal to 1 and lesser or equal to 99

Type: null

comment

Comment

Type: string Default: ""

Optional comment describing the extent.

naa Required

Naa

Type: string

Network Address Authority (NAA) identifier for the extent.

Must be at most 34 characters long

insecure_tpc

Insecure Tpc

Type: boolean Default: true

Whether to enable insecure Third Party Copy (TPC) operations.

xen

Xen

Type: boolean Default: false

Whether to enable Xen compatibility mode.

rpm

Rpm

Type: enum (of string) Default: "SSD"

Reported RPM type for the extent.

Must be one of:

• "UNKNOWN"
• "SSD"
• "5400"
• "7200"
• "10000"
• "15000"

ro

Ro

Type: boolean Default: false

Whether the extent is read-only.

enabled

Enabled

Type: boolean Default: true

Whether the extent is enabled and available for use.

vendor Required

Vendor

Type: string

Vendor string reported by the extent.

product_id

Product Id

Default: null

Product ID string for the extent or null for default.

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Must be at most 16 characters long

Type: null

locked Required

Locked

Read-only value indicating whether the iscsi extent is located on a locked dataset.

• true: The extent is in a locked dataset.
• false: The extent is not in a locked dataset.
• null: Lock status is not available because path locking information was not requested.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

Required roles: SHARING_ISCSI_EXTENT_WRITE