Get-SCVMConfiguration
Get-SCVMConfiguration
Gets the virtual machine configuration information for a service configuration or computer tier configuration.
Syntax
Parameter Set: All
Get-SCVMConfiguration [-All] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ID
Get-SCVMConfiguration [-ID <Guid> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ServiceConfig
Get-SCVMConfiguration -ServiceConfiguration <ServiceConfiguration> [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: TierConfig
Get-SCVMConfiguration -ComputerTierConfiguration <BaseComputerTierConfiguration> [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Get-SCVMConfiguration cmdlet gets virtual machine configuration information for a service configuration or computer tier configuration.
Parameters
-All
Retrieves a full list of all subordinate objects independent of the parent object. For example, the command Get-SCVirtualDiskDrive -All retrieves all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerTierConfiguration<BaseComputerTierConfiguration>
Specifies a computer tier configuration object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-ID<Guid>
Specifies the numerical identifier (as a globally unique identifier, or GUID) for a specific object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ServiceConfiguration<ServiceConfiguration>
Specifies a service configuration object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- VMConfiguration
Examples
1: Get all configuration information for a virtual machine within a computer tier configuration.
The first command gets the service configuration object named Service01 and stores the object in the $ServiceConfig variable.
The second command gets the computer tier configuration for the service configuration stored in $ServiceConfig and stores the object in the $TierConfig variable.
The third command gets the virtual machine configuration for the computer tier configuration stored in $TierConfig and stores the object in the $VMConfig variable.
The last command displays the properties of the virtual machine configuration stored in $VMConfig to the user.
PS C:\> $ServiceConfig = Get-SCServiceConfiguration -Name "Service01"
PS C:\> $TierConfig = Get-SCComputerTierConfiguration -ServiceConfiguration $ServiceConfig
PS C:\> $VMConfig = Get-SCVMConfiguration -ComputerTierConfiguration $TierConfig
PS C:\> $VMConfig
2: Get all configuration information for a virtual machine within a service configuration
The first command gets the service configuration named Service01 and stores the object in the $ServiceConfig variable.
The second command gets all virtrual machine configurations for the service configuration stored in $ServiceConfig and stores the objects in the $VMConfigs variable.
The last command displays the properties of the virtual machine configurations stored in $VMConfigs to the user.
PS C:\> $ServiceConfig = Get-SCServiceConfiguration -Name "Service01"
PS C:\> $VMConfigs = Get-SCVMConfiguration -ServiceConfiguration $ServiceConfig
PS C:\> $VMConfigs