Get-SCCloudUsage
Get-SCCloudUsage
Gets cloud usage data for a specified private cloud in VMM.
Syntax
Parameter Set: CloudUsage
Get-SCCloudUsage -Cloud <Cloud> [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: UserRoleUsageOfCloud
Get-SCCloudUsage -Cloud <Cloud> -UserRole <UserRole> [-UserName <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Get-SCCloudUsage cmdlet gets cloud usage data for a specified private cloud in Virtual Machine Manager (VMM). Cloud usage data includes the following:
- Number of CPUs
- Custom quota points
- Amount of memory (in MB)
- Amount of storage (in GB)
- Number of Virtual Machines
You can scope this data to usage per user role and per user.
Parameters
-Cloud<Cloud>
Specifies a private cloud object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-UserName<String>
Specifies a the name of a user. Enter a user name with the format Domain\User.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UserRole<UserRole>
Specifies a user role object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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.
Examples
1: Get the usage information for a specified private cloud.
The first command gets the private cloud object named Cloud01 and stores the object in the $Cloud variable.
The second command gets the cloud usage information for the private cloud stored in $Cloud and displays the following information to the user:
- CPUUsageCount
- CustomQuotaUsageCount
- MemoryUsageMB
- StorageUsageGB
- VMUsageCount
PS C:\> $Cloud = Get-SCCloud -Name "Cloud01"
PS C:\> Get-SCCloudUsage -Cloud $Cloud
2: Get the usage information for a specified private cloud for a specified user role.
The first command gets the private cloud object named Cloud01 and stores the object in the $Cloud variable.
The second command gets the user role object named SelfServiceUsers and stores the object in the $UserRole variable.
The last command gets the cloud usage information for the private cloud stored in $Cloud and the user role stored in $UserRole. Then, the command displays the cloud usage information to the user.
PS C:\> $Cloud = Get-SCCloud -Name "Cloud01"
PS C:\> $UserRole = Get-SCUserRole -Name "SelfServiceUsers"
PS C:\> Get-SCCloudUsage -Cloud $Cloud -UserRole $UserRole
3: Get the usage information for a specified private cloud for a specified user within a user role.
The first command gets the private cloud object named Cloud01 and stores the object in the $Cloud variable.
The second command gets the user role object named SelfServiceUsers and stores the object in the $UserRole variable.
The last command gets the cloud usage information for the private cloud stored in $Cloud and the user named Katarina who is in the user role named SelfServiceUsers. Then, the command displays the cloud usage information to the user.
PS C:\> $Cloud = Get-SCCloud -Name "Cloud01"
PS C:\> $UserRole = Get-SCUserRole -Name "SelfServiceUsers"
PS C:\> Get-SCCloudUsage -Cloud $Cloud -UserRole $UserRole -UserName "Contoso\Katarina"