az disk-pool iscsi-target
Note
This reference is part of the diskpool extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az disk-pool iscsi-target command. Learn more about extensions.
Manage iSCSI target with a Disk Pool.
Commands
Name | Description | Type | Status |
---|---|---|---|
az disk-pool iscsi-target create |
Create an iSCSI Target. |
Extension | GA |
az disk-pool iscsi-target delete |
Delete an iSCSI Target. |
Extension | GA |
az disk-pool iscsi-target list |
Get iSCSI Targets in a Disk pool. |
Extension | GA |
az disk-pool iscsi-target show |
Get an iSCSI Target. |
Extension | GA |
az disk-pool iscsi-target update |
Update an iSCSI Target. |
Extension | GA |
az disk-pool iscsi-target wait |
Place the CLI in a waiting state until a condition of the disk-pool iscsi-target is met. |
Extension | GA |
az disk-pool iscsi-target create
Create an iSCSI Target.
az disk-pool iscsi-target create --acl-mode {Dynamic, Static}
--disk-pool-name
--iscsi-target-name
--resource-group
[--luns]
[--managed-by]
[--managed-by-extended]
[--no-wait]
[--static-acls]
[--target-iqn]
Examples
Create or Update iSCSI Target
az disk-pool iscsi-target create --disk-pool-name "myDiskPool" --acl-mode "Dynamic" --luns name="lun0" managed-disk-azure-resource-id="/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm-name_DataDisk_1" --target-iqn "iqn.2005-03.org.iscsi:server1" --name "myIscsiTarget" --resource-group "myResourceGroup"
Required Parameters
Mode for Target connectivity.
The name of the Disk Pool.
The name of the iSCSI Target.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
List of LUNs to be exposed through iSCSI Target.
Usage: --luns name=XX managed-disk-azure-resource-id=XX
name: Required. User defined name for iSCSI LUN; example: "lun0" managed-disk-azure-resource-id: Required. Azure Resource ID of the Managed Disk.
Multiple actions can be specified by using more than one --luns argument.
Azure resource id. Indicates if this resource is managed by another Azure resource.
List of Azure resource ids that manage this resource.
Do not wait for the long-running operation to finish.
Access Control List (ACL) for an iSCSI Target; defines LUN masking policy.
Usage: --static-acls initiator-iqn=XX mapped-luns=XX
initiator-iqn: Required. iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". mapped-luns: Required. List of LUN names mapped to the ACL.
Multiple actions can be specified by using more than one --static-acls argument.
ISCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az disk-pool iscsi-target delete
Delete an iSCSI Target.
az disk-pool iscsi-target delete [--disk-pool-name]
[--ids]
[--iscsi-target-name]
[--no-wait]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete iSCSI Target
az disk-pool iscsi-target delete --disk-pool-name "myDiskPool" --name "myIscsiTarget" --resource-group "myResourceGroup"
Optional Parameters
The name of the Disk Pool.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the iSCSI Target.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az disk-pool iscsi-target list
Get iSCSI Targets in a Disk pool.
az disk-pool iscsi-target list --disk-pool-name
--resource-group
Examples
List Disk Pools by Resource Group
az disk-pool iscsi-target list --disk-pool-name "myDiskPool" --resource-group "myResourceGroup"
Required Parameters
The name of the Disk Pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az disk-pool iscsi-target show
Get an iSCSI Target.
az disk-pool iscsi-target show [--disk-pool-name]
[--ids]
[--iscsi-target-name]
[--resource-group]
[--subscription]
Examples
Get iSCSI Target
az disk-pool iscsi-target show --disk-pool-name "myDiskPool" --name "myIscsiTarget" --resource-group "myResourceGroup"
Optional Parameters
The name of the Disk Pool.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the iSCSI Target.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az disk-pool iscsi-target update
Update an iSCSI Target.
az disk-pool iscsi-target update [--disk-pool-name]
[--ids]
[--iscsi-target-name]
[--luns]
[--managed-by]
[--managed-by-extended]
[--no-wait]
[--resource-group]
[--static-acls]
[--subscription]
Examples
Update iSCSI Target
az disk-pool iscsi-target update --disk-pool-name "myDiskPool" --name "myIscsiTarget" --luns name="lun0" managed-disk-azure-resource-id="/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm-name_DataDisk_1"
Optional Parameters
The name of the Disk Pool.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the iSCSI Target.
List of LUNs to be exposed through iSCSI Target.
Usage: --luns name=XX managed-disk-azure-resource-id=XX
name: Required. User defined name for iSCSI LUN; example: "lun0" managed-disk-azure-resource-id: Required. Azure Resource ID of the Managed Disk.
Multiple actions can be specified by using more than one --luns argument.
Azure resource id. Indicates if this resource is managed by another Azure resource.
List of Azure resource ids that manage this resource.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Access Control List (ACL) for an iSCSI Target; defines LUN masking policy.
Usage: --static-acls initiator-iqn=XX mapped-luns=XX
initiator-iqn: Required. iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". mapped-luns: Required. List of LUN names mapped to the ACL.
Multiple actions can be specified by using more than one --static-acls argument.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az disk-pool iscsi-target wait
Place the CLI in a waiting state until a condition of the disk-pool iscsi-target is met.
az disk-pool iscsi-target wait [--created]
[--custom]
[--deleted]
[--disk-pool-name]
[--exists]
[--ids]
[--interval]
[--iscsi-target-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Examples
Pause executing next line of CLI script until the disk-pool iscsi-target is successfully created.
az disk-pool iscsi-target wait --disk-pool-name "myDiskPool" --name "myIscsiTarget" --resource-group "myResourceGroup" --created
Pause executing next line of CLI script until the disk-pool iscsi-target is successfully updated.
az disk-pool iscsi-target wait --disk-pool-name "myDiskPool" --name "myIscsiTarget" --resource-group "myResourceGroup" --updated
Pause executing next line of CLI script until the disk-pool iscsi-target is successfully deleted.
az disk-pool iscsi-target wait --disk-pool-name "myDiskPool" --name "myIscsiTarget" --resource-group "myResourceGroup" --deleted
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
The name of the Disk Pool.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
The name of the iSCSI Target.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.