From 366b04ec9520df859163d0b0411011bee50b18b5 Mon Sep 17 00:00:00 2001 From: Robert Simpson <323132+Rob-S@users.noreply.github.com> Date: Fri, 16 Jul 2021 16:05:42 -0500 Subject: [PATCH 1/7] Update Update-IscsiTargetPortal.md Fixed spot where two lines were merged into one --- docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md index 81be5ef6b8..3962e824df 100644 --- a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md +++ b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md @@ -44,7 +44,8 @@ InititorIPAdressListNumber : 4294967295 IsDataDigest : False IsHeaderDigest : False TargetPortalAddress : testiSCSI-deepcore -TargetPortalPortNumber : 3260 PS C:\> Get-IscsiTargetPortal | Update-IscsiTargetPortal +TargetPortalPortNumber : 3260 +PS C:\> Get-IscsiTargetPortal | Update-IscsiTargetPortal ``` This command updates information about the specified iSCSI target portal. From cfd307c851545f180733ba0777fcb70008e1963b Mon Sep 17 00:00:00 2001 From: Robert Simpson <323132+Rob-S@users.noreply.github.com> Date: Sun, 25 Jul 2021 23:07:39 -0500 Subject: [PATCH 2/7] Update Update-IscsiTargetPortal.md Based on requested change "it would look better if you enclose the commands and output"... The command and output were _already_ enclosed in a "```" block, starting with lines way above the one line that was changed for this patch. But the existing lines were enclosed in a single "```". So, not being clear about what was being asked to be changed, since only the last line within that already existing block was changed... simply added the "Output" tag between the commands and output - but again, that's _way_ above the line that was changed for this patch "patch-2". --- docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md index 3962e824df..6bb019a5ad 100644 --- a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md +++ b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md @@ -35,8 +35,9 @@ The **Update-IscsiTargetPortal** cmdlet refreshes cached information about an iS ## EXAMPLES ### Example 1: Update information about an iSCSI target portal -``` -PS C:\> Get-IscsiTargetPortal +```PowerShell +Get-IscsiTargetPortal +```Output InitiatorInstanceName : InitiatorNodeAddress : InitiatorPortalAddress : @@ -45,7 +46,8 @@ IsDataDigest : False IsHeaderDigest : False TargetPortalAddress : testiSCSI-deepcore TargetPortalPortNumber : 3260 -PS C:\> Get-IscsiTargetPortal | Update-IscsiTargetPortal +```PowerShell + Get-IscsiTargetPortal | Update-IscsiTargetPortal ``` This command updates information about the specified iSCSI target portal. From 708b3bb2f7f658869fdb58f8036a69ec4ba184e0 Mon Sep 17 00:00:00 2001 From: Robert Simpson <323132+Rob-S@users.noreply.github.com> Date: Tue, 27 Jul 2021 18:25:55 -0500 Subject: [PATCH 3/7] Update Update-IscsiTargetPortal.md Add ``` --- docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md index 6bb019a5ad..56afddae70 100644 --- a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md +++ b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md @@ -37,6 +37,7 @@ The **Update-IscsiTargetPortal** cmdlet refreshes cached information about an iS ### Example 1: Update information about an iSCSI target portal ```PowerShell Get-IscsiTargetPortal +``` ```Output InitiatorInstanceName : InitiatorNodeAddress : @@ -46,6 +47,7 @@ IsDataDigest : False IsHeaderDigest : False TargetPortalAddress : testiSCSI-deepcore TargetPortalPortNumber : 3260 +``` ```PowerShell Get-IscsiTargetPortal | Update-IscsiTargetPortal ``` From 2db5cf5ba8036a4da1b6ac562e3154e11e5c7ad1 Mon Sep 17 00:00:00 2001 From: Robert Simpson <323132+Rob-S@users.noreply.github.com> Date: Tue, 27 Jul 2021 18:27:57 -0500 Subject: [PATCH 4/7] Update Update-IscsiTargetPortal.md --- .../winserver2019-ps/iscsi/Update-IscsiTargetPortal.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md index 56afddae70..0aebcf05c1 100644 --- a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md +++ b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md @@ -35,9 +35,11 @@ The **Update-IscsiTargetPortal** cmdlet refreshes cached information about an iS ## EXAMPLES ### Example 1: Update information about an iSCSI target portal +This command updates information about the specified iSCSI target portal. ```PowerShell Get-IscsiTargetPortal ``` +The first command displays target portals by using the **Get-IscsiTargetPortal** cmdlet. ```Output InitiatorInstanceName : InitiatorNodeAddress : @@ -48,16 +50,11 @@ IsHeaderDigest : False TargetPortalAddress : testiSCSI-deepcore TargetPortalPortNumber : 3260 ``` +The second command passes the same target portals to the current cmdlet to update them. ```PowerShell Get-IscsiTargetPortal | Update-IscsiTargetPortal ``` -This command updates information about the specified iSCSI target portal. - -The first command displays target portals by using the **Get-IscsiTargetPortal** cmdlet. - -The second command passes the same target portals to the current cmdlet to update them. - ## PARAMETERS ### -AsJob From 8144087ff7e288c46db2ecbca9d73414e0493070 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Thu, 29 Jul 2021 08:31:44 -0500 Subject: [PATCH 5/7] Cleanup formatting --- .../iscsi/Update-IscsiTargetPortal.md | 31 ++++++++++++++++--- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md index 0aebcf05c1..4d333f9b16 100644 --- a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md +++ b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md @@ -16,6 +16,7 @@ Updates information about the specified iSCSI target portal. ## SYNTAX ### ByTargetPortalAddress (Default) + ``` Update-IscsiTargetPortal [-TargetPortalAddress] [-InitiatorInstanceName ] [-InitiatorPortalAddress ] [-TargetPortalPortNumber ] [-CimSession ] @@ -23,6 +24,7 @@ Update-IscsiTargetPortal [-TargetPortalAddress] [-InitiatorInstanceNa ``` ### InputObject (cdxml) + ``` Update-IscsiTargetPortal -InputObject [-InitiatorInstanceName ] [-InitiatorPortalAddress ] [-TargetPortalPortNumber ] [-CimSession ] @@ -30,16 +32,21 @@ Update-IscsiTargetPortal -InputObject [-InitiatorInstanceName Date: Thu, 29 Jul 2021 08:34:39 -0500 Subject: [PATCH 6/7] Fix platyps schema violation --- docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md index 4d333f9b16..1a1c7b15e9 100644 --- a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md +++ b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md @@ -40,13 +40,12 @@ The `Update-IscsiTargetPortal` cmdlet refreshes cached information about an iSCS ### Example 1: Update information about an iSCSI target portal This command updates information about the specified iSCSI target portal. +The first command displays target portals by using the **Get-IscsiTargetPortal** cmdlet. ```PowerShell Get-IscsiTargetPortal ``` -The first command displays target portals by using the **Get-IscsiTargetPortal** cmdlet. - ```Output InitiatorInstanceName : InitiatorNodeAddress : @@ -58,11 +57,10 @@ TargetPortalAddress : testiSCSI-deepcore TargetPortalPortNumber : 3260 ``` -The second command passes the same target portals to the current cmdlet to update them. - ```PowerShell Get-IscsiTargetPortal | Update-IscsiTargetPortal ``` +The second command passes the same target portals to the current cmdlet to update them. ## PARAMETERS From 84c041a1d558503a0e12da3c5ae1696e8080f44d Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Thu, 29 Jul 2021 14:49:04 -0500 Subject: [PATCH 7/7] format cleanup --- .../iscsi/Update-IscsiTargetPortal.md | 87 +++++++++++++------ .../iscsi/Update-IscsiTargetPortal.md | 86 +++++++++++------- .../iscsi/Update-IscsiTargetPortal.md | 60 ++++++++----- .../iscsi/Update-IscsiTargetPortal.md | 23 +++-- .../iscsi/Update-IscsiTargetPortal.md | 60 ++++++++----- 5 files changed, 207 insertions(+), 109 deletions(-) diff --git a/docset/winserver2012-ps/iscsi/Update-IscsiTargetPortal.md b/docset/winserver2012-ps/iscsi/Update-IscsiTargetPortal.md index aa62076e19..d4a61f8b3a 100644 --- a/docset/winserver2012-ps/iscsi/Update-IscsiTargetPortal.md +++ b/docset/winserver2012-ps/iscsi/Update-IscsiTargetPortal.md @@ -27,13 +27,21 @@ Update-IscsiTargetPortal [-AsJob] [-CimSession ] [-InitiatorInstan ``` ## DESCRIPTION -The **Update-IscsiTargetPortal** cmdlet refreshes cached information about an iSCSI target portal. + +The `Update-IscsiTargetPortal` cmdlet refreshes cached information about an iSCSI target portal. ## EXAMPLES -### Example 1 +### Example 1: Update information about an iSCSI target portal + +This command updates information about the specified iSCSI target portal. +The first command displays target portals by using the **Get-IscsiTargetPortal** cmdlet. + +```powershell +Get-IscsiTargetPortal ``` -PS C:\>Get-IscsiTargetPortal + +```Output InitiatorInstanceName : InitiatorNodeAddress : InitiatorPortalAddress : @@ -41,23 +49,31 @@ InititorIPAdressListNumber : 4294967295 IsDataDigest : False IsHeaderDigest : False TargetPortalAddress : testiSCSI-deepcore -TargetPortalPortNumber : 3260 - - -PS C:\>Get-IscsiTargetPortal | Update-IscsiTargetPortal +TargetPortalPortNumber : 3260 ``` -This example returns information about iSCSI target portals that have previously been added. +```powershell +Get-IscsiTargetPortal | Update-IscsiTargetPortal +``` +The second command passes the same target portals to the current cmdlet to update them. ## PARAMETERS ### -AsJob -ps_cimcommon_asjob + +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +The cmdlet immediately returns an object that represents the job and then displays the command prompt. +You can continue to work in the session while the job completes. +To manage the job, use the `*-Job` cmdlets. +To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -67,8 +83,10 @@ Accept wildcard characters: False ``` ### -CimSession + Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. +Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) +or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the current session on the local computer. ```yaml @@ -85,11 +103,13 @@ Accept wildcard characters: False ### -InitiatorInstanceName +Specifies the name of the initiator instance that the iSCSI initiator service uses to send **SendTargets** requests to the target portal. +If no instance name is specified, the iSCSI initiator service chooses the initiator instance. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -99,12 +119,13 @@ Accept wildcard characters: False ``` ### -InitiatorPortalAddress -Represents the IP address or DNS name associated with the portal. + +Specifies the IP address or DNS name that is associated with the portal. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -114,12 +135,14 @@ Accept wildcard characters: False ``` ### -InputObject -Accepts an object from the pipeline as input. + +Specifies the input to this cmdlet. +You can use this parameter, or you can pipe the input to this cmdlet. ```yaml Type: CimInstance[] Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: +Aliases: Required: True Position: Named @@ -129,17 +152,14 @@ Accept wildcard characters: False ``` ### -PassThru -Sends items from the interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. - -To send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -149,12 +169,13 @@ Accept wildcard characters: False ``` ### -TargetPortalAddress -Represents the IP address or DNS name of the target portal. + +Specifies the IP address or DNS name of the target portal. ```yaml Type: String[] Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: +Aliases: Required: True Position: 1 @@ -164,13 +185,14 @@ Accept wildcard characters: False ``` ### -TargetPortalPortNumber + Specifies the TCP/IP port number for the target portal. By default, the port number is `3260`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -180,14 +202,16 @@ Accept wildcard characters: False ``` ### -ThrottleLimit + Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -196,9 +220,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal + The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. @@ -210,6 +239,8 @@ The path after the pound sign (`#`) provides the namespace and class name for th ## RELATED LINKS -[iSCSI Target Server Overview](https://docs.microsoft.com/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) +[iSCSI on TechNet](/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/ee338476(v=ws.10)) + +[Storage on TechNet](https://go.microsoft.com/fwlink/?linkid=191356) [Get-IscsiTargetPortal](./Get-IscsiTargetPortal.md) diff --git a/docset/winserver2012r2-ps/iscsi/Update-IscsiTargetPortal.md b/docset/winserver2012r2-ps/iscsi/Update-IscsiTargetPortal.md index ce32ff2eb3..2ab962a4ec 100644 --- a/docset/winserver2012r2-ps/iscsi/Update-IscsiTargetPortal.md +++ b/docset/winserver2012r2-ps/iscsi/Update-IscsiTargetPortal.md @@ -6,7 +6,6 @@ online version: https://docs.microsoft.com/powershell/module/iscsi/update-iscsit schema: 2.0.0 title: Update-IscsiTargetPortal --- - # Update-IscsiTargetPortal ## SYNOPSIS @@ -15,6 +14,7 @@ Updates information about the specified iSCSI target portal. ## SYNTAX ### ByTargetPortalAddress (Default) + ``` Update-IscsiTargetPortal [-TargetPortalAddress] [-InitiatorInstanceName ] [-InitiatorPortalAddress ] [-TargetPortalPortNumber ] [-CimSession ] @@ -22,6 +22,7 @@ Update-IscsiTargetPortal [-TargetPortalAddress] [-InitiatorInstanceNa ``` ### InputObject (cdxml) + ``` Update-IscsiTargetPortal -InputObject [-InitiatorInstanceName ] [-InitiatorPortalAddress ] [-TargetPortalPortNumber ] [-CimSession ] @@ -29,13 +30,21 @@ Update-IscsiTargetPortal -InputObject [-InitiatorInstanceName Get-IscsiTargetPortal + +```Output InitiatorInstanceName : InitiatorNodeAddress : InitiatorPortalAddress : @@ -43,20 +52,31 @@ InititorIPAdressListNumber : 4294967295 IsDataDigest : False IsHeaderDigest : False TargetPortalAddress : testiSCSI-deepcore -TargetPortalPortNumber : 3260 PS C:\> Get-IscsiTargetPortal | Update-IscsiTargetPortal +TargetPortalPortNumber : 3260 ``` -This example returns information about iSCSI target portals that have previously been added. +```powershell +C:\> Get-IscsiTargetPortal | Update-IscsiTargetPortal +``` +The second command passes the same target portals to the current cmdlet to update them. ## PARAMETERS ### -AsJob -ps_cimcommon_asjob + +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +The cmdlet immediately returns an object that represents the job and then displays the command prompt. +You can continue to work in the session while the job completes. +To manage the job, use the `*-Job` cmdlets. +To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -66,8 +86,10 @@ Accept wildcard characters: False ``` ### -CimSession + Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. +Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) +or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the current session on the local computer. ```yaml @@ -83,13 +105,14 @@ Accept wildcard characters: False ``` ### -InitiatorInstanceName + Specifies the name of the initiator instance that the iSCSI initiator service uses to send **SendTargets** requests to the target portal. If no instance name is specified, the iSCSI initiator service chooses the initiator instance. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -99,12 +122,13 @@ Accept wildcard characters: False ``` ### -InitiatorPortalAddress -Represents the IP address or DNS name associated with the portal. + +Specifies the IP address or DNS name that is associated with the portal. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -114,12 +138,14 @@ Accept wildcard characters: False ``` ### -InputObject -Accepts an object from the pipeline as input. + +Specifies the input to this cmdlet. +You can use this parameter, or you can pipe the input to this cmdlet. ```yaml Type: CimInstance[] Parameter Sets: InputObject (cdxml) -Aliases: +Aliases: Required: True Position: Named @@ -129,16 +155,14 @@ Accept wildcard characters: False ``` ### -PassThru -Sends items from the interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. - -To send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. + +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -148,12 +172,13 @@ Accept wildcard characters: False ``` ### -TargetPortalAddress -Represents the IP address or DNS name of the target portal. + +Specifies the IP address or DNS name of the target portal. ```yaml Type: String[] Parameter Sets: ByTargetPortalAddress -Aliases: +Aliases: Required: True Position: 0 @@ -163,13 +188,14 @@ Accept wildcard characters: False ``` ### -TargetPortalPortNumber + Specifies the TCP/IP port number for the target portal. By default, the port number is `3260`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -179,14 +205,16 @@ Accept wildcard characters: False ``` ### -ThrottleLimit + Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -196,11 +224,13 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal + The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. @@ -212,10 +242,8 @@ The path after the pound sign (`#`) provides the namespace and class name for th ## RELATED LINKS -[iSCSI on TechNet](https://www.microsoft.com/iSCSI) +[iSCSI on TechNet](/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/ee338476(v=ws.10)) [Storage on TechNet](https://go.microsoft.com/fwlink/?linkid=191356) [Get-IscsiTargetPortal](./Get-IscsiTargetPortal.md) - - diff --git a/docset/winserver2016-ps/iscsi/Update-IscsiTargetPortal.md b/docset/winserver2016-ps/iscsi/Update-IscsiTargetPortal.md index 7f354b8eba..6404d6a9df 100644 --- a/docset/winserver2016-ps/iscsi/Update-IscsiTargetPortal.md +++ b/docset/winserver2016-ps/iscsi/Update-IscsiTargetPortal.md @@ -7,7 +7,6 @@ online version: https://docs.microsoft.com/powershell/module/iscsi/update-iscsit schema: 2.0.0 title: Update-IscsiTargetPortal --- - # Update-IscsiTargetPortal ## SYNOPSIS @@ -16,6 +15,7 @@ Updates information about the specified iSCSI target portal. ## SYNTAX ### ByTargetPortalAddress (Default) + ``` Update-IscsiTargetPortal [-TargetPortalAddress] [-InitiatorInstanceName ] [-InitiatorPortalAddress ] [-TargetPortalPortNumber ] [-CimSession ] @@ -23,6 +23,7 @@ Update-IscsiTargetPortal [-TargetPortalAddress] [-InitiatorInstanceNa ``` ### InputObject (cdxml) + ``` Update-IscsiTargetPortal -InputObject [-InitiatorInstanceName ] [-InitiatorPortalAddress ] [-TargetPortalPortNumber ] [-CimSession ] @@ -30,13 +31,21 @@ Update-IscsiTargetPortal -InputObject [-InitiatorInstanceName Get-IscsiTargetPortal + +```Output InitiatorInstanceName : InitiatorNodeAddress : InitiatorPortalAddress : @@ -44,18 +53,18 @@ InititorIPAdressListNumber : 4294967295 IsDataDigest : False IsHeaderDigest : False TargetPortalAddress : testiSCSI-deepcore -TargetPortalPortNumber : 3260 PS C:\> Get-IscsiTargetPortal | Update-IscsiTargetPortal +TargetPortalPortNumber : 3260 ``` -This command updates information about the specified iSCSI target portal. - -The first command displays target portals by using the **Get-IscsiTargetPortal** cmdlet. - +```powershell +Get-IscsiTargetPortal | Update-IscsiTargetPortal +``` The second command passes the same target portals to the current cmdlet to update them. ## PARAMETERS ### -AsJob + Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. @@ -68,7 +77,7 @@ For more information about Windows PowerShell background jobs, see [about_Jobs]( ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -78,8 +87,10 @@ Accept wildcard characters: False ``` ### -CimSession + Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. +Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) +or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the current session on the local computer. ```yaml @@ -95,13 +106,14 @@ Accept wildcard characters: False ``` ### -InitiatorInstanceName + Specifies the name of the initiator instance that the iSCSI initiator service uses to send **SendTargets** requests to the target portal. If no instance name is specified, the iSCSI initiator service chooses the initiator instance. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -111,12 +123,13 @@ Accept wildcard characters: False ``` ### -InitiatorPortalAddress + Specifies the IP address or DNS name that is associated with the portal. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -126,13 +139,14 @@ Accept wildcard characters: False ``` ### -InputObject + Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet. ```yaml Type: CimInstance[] Parameter Sets: InputObject (cdxml) -Aliases: +Aliases: Required: True Position: Named @@ -142,13 +156,14 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -158,12 +173,13 @@ Accept wildcard characters: False ``` ### -TargetPortalAddress + Specifies the IP address or DNS name of the target portal. ```yaml Type: String[] Parameter Sets: ByTargetPortalAddress -Aliases: +Aliases: Required: True Position: 0 @@ -173,13 +189,14 @@ Accept wildcard characters: False ``` ### -TargetPortalPortNumber + Specifies the TCP/IP port number for the target portal. -By default, the port number is 3260. +By default, the port number is `3260`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -189,14 +206,16 @@ Accept wildcard characters: False ``` ### -ThrottleLimit + Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -206,11 +225,13 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal + The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. @@ -227,4 +248,3 @@ The path after the pound sign (`#`) provides the namespace and class name for th [Storage on TechNet](https://go.microsoft.com/fwlink/?linkid=191356) [Get-IscsiTargetPortal](./Get-IscsiTargetPortal.md) - diff --git a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md index 1a1c7b15e9..82f6e6e639 100644 --- a/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md +++ b/docset/winserver2019-ps/iscsi/Update-IscsiTargetPortal.md @@ -7,7 +7,6 @@ online version: https://docs.microsoft.com/powershell/module/iscsi/update-iscsit schema: 2.0.0 title: Update-IscsiTargetPortal --- - # Update-IscsiTargetPortal ## SYNOPSIS @@ -42,7 +41,7 @@ The `Update-IscsiTargetPortal` cmdlet refreshes cached information about an iSCS This command updates information about the specified iSCSI target portal. The first command displays target portals by using the **Get-IscsiTargetPortal** cmdlet. -```PowerShell +```powershell Get-IscsiTargetPortal ``` @@ -57,7 +56,7 @@ TargetPortalAddress : testiSCSI-deepcore TargetPortalPortNumber : 3260 ``` -```PowerShell +```powershell Get-IscsiTargetPortal | Update-IscsiTargetPortal ``` The second command passes the same target portals to the current cmdlet to update them. @@ -78,7 +77,7 @@ For more information about Windows PowerShell background jobs, see [about_Jobs]( ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -114,7 +113,7 @@ If no instance name is specified, the iSCSI initiator service chooses the initia ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -130,7 +129,7 @@ Specifies the IP address or DNS name that is associated with the portal. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -147,7 +146,7 @@ You can use this parameter, or you can pipe the input to this cmdlet. ```yaml Type: CimInstance[] Parameter Sets: InputObject (cdxml) -Aliases: +Aliases: Required: True Position: Named @@ -164,7 +163,7 @@ By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -180,7 +179,7 @@ Specifies the IP address or DNS name of the target portal. ```yaml Type: String[] Parameter Sets: ByTargetPortalAddress -Aliases: +Aliases: Required: True Position: 0 @@ -192,12 +191,12 @@ Accept wildcard characters: False ### -TargetPortalPortNumber Specifies the TCP/IP port number for the target portal. -By default, the port number is 3260. +By default, the port number is `3260`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -216,7 +215,7 @@ The throttle limit applies only to the current cmdlet, not to the session or to ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/docset/winserver2022-ps/iscsi/Update-IscsiTargetPortal.md b/docset/winserver2022-ps/iscsi/Update-IscsiTargetPortal.md index 0de9a56f66..1d0e032ff0 100644 --- a/docset/winserver2022-ps/iscsi/Update-IscsiTargetPortal.md +++ b/docset/winserver2022-ps/iscsi/Update-IscsiTargetPortal.md @@ -7,7 +7,6 @@ online version: https://docs.microsoft.com/powershell/module/iscsi/update-iscsit schema: 2.0.0 title: Update-IscsiTargetPortal --- - # Update-IscsiTargetPortal ## SYNOPSIS @@ -16,6 +15,7 @@ Updates information about the specified iSCSI target portal. ## SYNTAX ### ByTargetPortalAddress (Default) + ``` Update-IscsiTargetPortal [-TargetPortalAddress] [-InitiatorInstanceName ] [-InitiatorPortalAddress ] [-TargetPortalPortNumber ] [-CimSession ] @@ -23,6 +23,7 @@ Update-IscsiTargetPortal [-TargetPortalAddress] [-InitiatorInstanceNa ``` ### InputObject (cdxml) + ``` Update-IscsiTargetPortal -InputObject [-InitiatorInstanceName ] [-InitiatorPortalAddress ] [-TargetPortalPortNumber ] [-CimSession ] @@ -30,13 +31,21 @@ Update-IscsiTargetPortal -InputObject [-InitiatorInstanceName Get-IscsiTargetPortal + +```Output InitiatorInstanceName : InitiatorNodeAddress : InitiatorPortalAddress : @@ -44,18 +53,18 @@ InititorIPAdressListNumber : 4294967295 IsDataDigest : False IsHeaderDigest : False TargetPortalAddress : testiSCSI-deepcore -TargetPortalPortNumber : 3260 PS C:\> Get-IscsiTargetPortal | Update-IscsiTargetPortal +TargetPortalPortNumber : 3260 ``` -This command updates information about the specified iSCSI target portal. - -The first command displays target portals by using the **Get-IscsiTargetPortal** cmdlet. - +```powershell +Get-IscsiTargetPortal | Update-IscsiTargetPortal +``` The second command passes the same target portals to the current cmdlet to update them. ## PARAMETERS ### -AsJob + Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. @@ -68,7 +77,7 @@ For more information about Windows PowerShell background jobs, see [about_Jobs]( ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -78,8 +87,10 @@ Accept wildcard characters: False ``` ### -CimSession + Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. +Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) +or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the current session on the local computer. ```yaml @@ -95,13 +106,14 @@ Accept wildcard characters: False ``` ### -InitiatorInstanceName + Specifies the name of the initiator instance that the iSCSI initiator service uses to send **SendTargets** requests to the target portal. If no instance name is specified, the iSCSI initiator service chooses the initiator instance. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -111,12 +123,13 @@ Accept wildcard characters: False ``` ### -InitiatorPortalAddress + Specifies the IP address or DNS name that is associated with the portal. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -126,13 +139,14 @@ Accept wildcard characters: False ``` ### -InputObject + Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet. ```yaml Type: CimInstance[] Parameter Sets: InputObject (cdxml) -Aliases: +Aliases: Required: True Position: Named @@ -142,13 +156,14 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -158,12 +173,13 @@ Accept wildcard characters: False ``` ### -TargetPortalAddress + Specifies the IP address or DNS name of the target portal. ```yaml Type: String[] Parameter Sets: ByTargetPortalAddress -Aliases: +Aliases: Required: True Position: 0 @@ -173,13 +189,14 @@ Accept wildcard characters: False ``` ### -TargetPortalPortNumber + Specifies the TCP/IP port number for the target portal. -By default, the port number is 3260. +By default, the port number is `3260`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -189,14 +206,16 @@ Accept wildcard characters: False ``` ### -ThrottleLimit + Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -206,11 +225,13 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal + The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. @@ -227,4 +248,3 @@ The path after the pound sign (`#`) provides the namespace and class name for th [Storage on TechNet](https://go.microsoft.com/fwlink/?linkid=191356) [Get-IscsiTargetPortal](./Get-IscsiTargetPortal.md) -