Get-SmsState

Module:

StorageMigrationService Module

{{ Fill in the Synopsis }}

Syntax

Job Summary (Default)

Get-SmsState
    [[-Name] <String>]
    [-JobSummary]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Inventory Config Detail

Get-SmsState
    [-Name] <String>
    -ComputerName <String>
    [-InventoryConfigDetail]
    [-IncludeAllAdapters]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Inventory SMB Detail

Get-SmsState
    [-Name] <String>
    -ComputerName <String>
    [-InventorySMBDetail]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Inventory DFSN Detail

Get-SmsState
    [-Name] <String>
    -ComputerName <String>
    [-InventoryDFSNDetail]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Transfer SMB Detail

Get-SmsState
    [-Name] <String>
    -ComputerName <String>
    [-TransferSMBDetail]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Transfer DFSN Detail

Get-SmsState
    [-Name] <String>
    -ComputerName <String>
    [-TransferDFSNDetail]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Transfer File Detail

Get-SmsState
    [-Name] <String>
    -ComputerName <String>
    [-TransferFileDetail]
    [-ErrorsOnly]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Transfer Volume Detail

Get-SmsState
    [-Name] <String>
    -ComputerName <String>
    [-TransferVolumeDetail]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [-VolumeTypes <VolumeType>]
    [<CommonParameters>]

Cutover Summary

Get-SmsState
    [-Name] <String>
    [-ComputerName <String>]
    [-CutoverSummary]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Get Local User Detail

Get-SmsState
    [-Name] <String>
    -ComputerName <String>
    [-GetLocalUsersDetail]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Get Local Groups Detail

Get-SmsState
    [-Name] <String>
    -ComputerName <String>
    [-GetLocalGroupsDetail]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Get NasPrescanResult Detail

Get-SmsState
    [-Name] <String>
    -NasController <String>
    [-GetNasPrescanResult]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Inventory Summary

Get-SmsState
    [-Name] <String>
    [-InventorySummary]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Transfer Summary

Get-SmsState
    [-Name] <String>
    [-TransferSummary]
    [-OrchestratorComputerName <String>]
    [-OrchestratorPort <Int32>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Description

{{ Fill in the Description }}

Examples

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

Parameters

-ComputerName

{{ Fill ComputerName Description }}

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	CN

Parameter sets

Inventory Config Detail

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

Inventory SMB Detail

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

Inventory DFSN Detail

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

Transfer SMB Detail

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

Transfer DFSN Detail

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

Transfer File Detail

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

Transfer Volume Detail

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

Get Local User Detail

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

Get Local Groups Detail

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Credential

{{ Fill Credential Description }}

Parameter properties

Type:	PSCredential
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	C

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CutoverSummary

{{ Fill CutoverSummary Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	CS

Parameter sets

Cutover Summary

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ErrorsOnly

{{ Fill ErrorsOnly Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Transfer File Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-GetLocalGroupsDetail

{{ Fill GetLocalGroupsDetail Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	GLGD

Parameter sets

Get Local Groups Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-GetLocalUsersDetail

{{ Fill GetLocalUsersDetail Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	GLUD

Parameter sets

Get Local User Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-GetNasPrescanResult

{{ Fill GetNasPrescanResult Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Get NasPrescanResult Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-IncludeAllAdapters

{{ Fill IncludeAllAdapters Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Inventory Config Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InventoryConfigDetail

{{ Fill InventoryConfigDetail Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	ICD

Parameter sets

Inventory Config Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InventoryDFSNDetail

{{ Fill InventoryDFSNDetail Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	IDD

Parameter sets

Inventory DFSN Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InventorySMBDetail

{{ Fill InventorySMBDetail Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	ISD

Parameter sets

Inventory SMB Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InventorySummary

{{ Fill InventorySummary Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	IS

Parameter sets

Inventory Summary

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-JobSummary

{{ Fill JobSummary Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	JS

Parameter sets

Job Summary

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

{{ Fill Name Description }}

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	N

Parameter sets

Job Summary

Position:	0
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

-NasController

{{ Fill NasController Description }}

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Get NasPrescanResult Detail

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-OrchestratorComputerName

{{ Fill OrchestratorComputerName Description }}

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	OCN

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OrchestratorPort

{{ Fill OrchestratorPort Description }}

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	OP

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TransferDFSNDetail

{{ Fill TransferDFSNDetail Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	TDD

Parameter sets

Transfer DFSN Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TransferFileDetail

{{ Fill TransferFileDetail Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	TFD

Parameter sets

Transfer File Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TransferSMBDetail

{{ Fill TransferSMBDetail Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	TSD

Parameter sets

Transfer SMB Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TransferSummary

{{ Fill TransferSummary Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	TS

Parameter sets

Transfer Summary

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TransferVolumeDetail

{{ Fill TransferVolumeDetail Description }}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	TVD

Parameter sets

Transfer Volume Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VolumeTypes

{{ Fill VolumeTypes Description }}

Parameter properties

Type:	Microsoft.StorageMigration.Commands.GetSmsStateCommand+VolumeType
Default value:	None
Accepted values:	TAFSEnabled, NonTAFSEnabled, All
Supports wildcards:	False
DontShow:	False
Aliases:	VT

Parameter sets

Transfer Volume Detail

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Microsoft.StorageMigration.Commands.GetSmsStateCommand+VolumeType

Outputs

Object