| PowerShell Cmdlet |
Description, Code, and Syntax |
| Add-SCACShare |
Adds a library share. (Function)
Parameter Set: __AllParameterSets
Add-SCACShare [-SharePath] <String> [ <CommonParameters>]
PS C:\> Add-SCACShare -Path "\\LibraryServer\LibraryPath"
|
| Add-SCACUserRole |
Creates an App Controller user role. (Function)
Parameter Set: Default
Add-SCACUserRole [-Name] <String> [-Description <String> ] [-IsReadOnly] [ <CommonParameters>]
PS C:\>Add-SCACUserRole -Name "UserRole01"
-Description "Test User Role" -IsReadOnly
|
| Add-SCACUserRoleMember |
Adds a member to a user role. (Function)
Parameter Set: Default
Add-SCACUserRoleMember [-UserRole] <ACUserRole> [-Member]
<String> [ <CommonParameters>]
PS C:\> $UserRole = Get-SCACUserRole –Managed | where
{ $_.Name –eq "UserRole01" }
PS C:\> Add-SCACUserRoleMember –UserRole
$UserRole –Member "Contoso\ReneeLo"
|
| Add-SCACUserRoleScope |
Adds Service Provider Foundation connection cloud objects to the scope of objects that a user role can manage. (Function)
Parameter Set: AzureScope
Add-SCACUserRoleScope [-UserRole] <ACUserRole>
[-AzureSubscriptionScope] <ACAzureSubscriptionCloud>
[ <CommonParameters>]
Parameter Set: SPFScope
Add-SCACUserRoleScope [-UserRole] <ACUserRole>
[-ServiceProviderConnectionScope] <ACCloudSystem>
[-VmmUserRoleName] <String> [ <CommonParameters>]
PS C:\> $UserRole = Get-SCACUserRole -Managed |
where {$_.Name -eq "UserRole01"}
PS C:\> $CloudSystem = Get-SCACCloudSystem -Name
"SvcProvider01.Contoso.com"
PS C:\> Add-SCACUserRoleScope -UserRole $UserRole
-ServiceProviderConnectionScope $CloudSystem -VMMUserRoleName
"TenantSSUserRole01"
|
| Remove-SCACAzureSubscription |
Removes a Windows Azure subscription from App Controller. (Function)
Parameter Set: Default
Remove-SCACAzureSubscription [-Subscription]
<ACAzureSubscriptionCloud> [ <CommonParameters>]
PS C:\> $Cloud = Get-SCACCloud | where { $_.Name
–eq “AzureSubscription01” }
PS C:\> Remove-SCACAzureSubscription
–Subscription $Cloud
|
| Remove-SCACCloudSystem |
Removes a connection to a cloud system. (Function)
Parameter Set: Default
Remove-SCACCloudSystem [-CloudSystem] <ACCloudSystem>
[ <CommonParameters>]
PS C:\> $CloudSystem = Get-SCACCloudSystem -Name
"Management.Core.Windows.Net"
PS C:\> Remove-SCACCloudSystem
–CloudSystem $CloudSystem
|
| Remove-SCACShare |
Removes a library share. (Function)
Parameter Set: Default
Remove-SCACShare [-Path] <String> [ <CommonParameters>]
PS C:\> Remove-SCACShare -Path “\\LibraryServer\LibraryShare”
|
| Remove-SCACUserRole |
Removes the specified user role. (Function)
Parameter Set: Default
Remove-SCACUserRole [-UserRole] <ACUserRole>
[ <CommonParameters>]
PS C:\> $UserRole = Get-SCACUserRole –Managed | where
{ $_.Name –eq “UserRole01” }
PS C:\> Remove-SCACUserRole
–UserRole $UserRole
|
| Remove-SCACUserRoleMember |
Removes a member from a user role. (Function)
Parameter Set: Default
Remove-SCACUserRoleMember [-UserRole] <ACUserRole>
[-Member] <String> [ <CommonParameters>]
PS C:\> $UserRole = Get-SCACUserRole –Managed | where
{ $_.Name –eq "UserRole01" }
PS C:\> Remove-SCACUserRoleMember
–UserRole $UserRole –Member "Contoso\ReneeLo"
|
| Remove-SCACUserRoleScope |
Removes a Windows Azure subscription cloud object from the scope of objects that a user role can manage. (Function)
Parameter Set: Default
Remove-SCACUserRoleScope [-UserRole] <ACUserRole>
[-Scope] <ACAzureSubscriptionCloud> [ <CommonParameters>]
PS C:\> $UserRole = Get-SCACUserRole –Managed | where
{ $_.Name –eq “UserRole01” }
PS C:\> $Scope = Get-SCACCloud |
where { $_.Name –eq “AzureSubscription01” }
PS C:\> Remove-SCACUserRoleScope -UserRole $
UserRole -Scope $Scope
|
| Add-SCACAzureDisk |
Adds a virtual hard disk to Windows Azure. (Cmdlet)
Parameter Set: SourcePath
Add-SCACAzureDisk -Cloud <ACAzureSubscriptionCloud>
-DisplayName <String> -Name <String>
-OperatingSystem <OperatingSystemType>
-SourcePath <String> -StorageBlob
<Uri> [-Force] [ <CommonParameters>]
Parameter Set: SourceVHD
Add-SCACAzureDisk -Cloud <ACAzureSubscriptionCloud>
-DisplayName <String> -Name <String>
-OperatingSystem <OperatingSystemType>
-SourceVHD <StandaloneVirtualHardDisk>
-StorageBlob <Uri> [-Force]
[ <CommonParameters>]
PS C:\> $Clouds = Get-SCACCloud
PS C:\> Add-SCACAzureDisk
-Name "VHD01" -DisplayName "VHD01.vhd"
-Cloud $Clouds[0] -StorageBlob
"https://container01.blob.core.windows.net/vhds/VHD01.vhd"
-SourcePath “\\FileShare\VMs\Vhd01.vhd"
-OperatingSystem "Windows" -Force
|
| Add-SCACAzureImage |
Adds a virtual hard drive to the Windows Azure image store. (Cmdlet)
Parameter Set: SourcePath
Add-SCACAzureImage -Cloud <ACAzureSubscriptionCloud>
-DisplayName <String> -Name <String> -OperatingSystem
<OperatingSystemType> -SourcePath <String> -StorageBlob
<Uri> [-Force] [ <CommonParameters>]
Parameter Set: SourceVHD
Add-SCACAzureImage -Cloud <ACAzureSubscriptionCloud>
-DisplayName <String> -Name <String> -OperatingSystem
<OperatingSystemType> -SourceVHD <StandaloneVirtualHardDisk>
-StorageBlob <Uri> [-Force] [ <CommonParameters>]
PS C:\> $Clouds = Get-SCACCloud
PS C:\> $VHD = Get-SCVirtualHardDisk -Name "VHD01.vhd"
PS C:\> Add-SCACAzureImage –Name "Image01"
-DisplayName "Image01" -Cloud $Clouds[0] -StorageBlob
"http://container01.blob.core.windows.net/vhds/VHD01.vhd"
-SourceVHD $VHD -OperatingSystem "Windows"
|
| Add-SCACAzureSubscription |
Adds a Windows Azure subscription to App Controller. (Cmdlet)
Parameter Set: Default
Add-SCACAzureSubscription [-Name] <String>
[-Id] <Guid> [-ManagementCertificatePath]
<String> [-ManagementCertificatePassword]
<SecureString> [-Description <String> ]
[ <CommonParameters>]
PS C:\> $MCPassword = ConvertTo-SecureString
"PassWord!" -AsPlainText -Force
PS C:\> Add-SCACAzureSubscription –Id
"1626950e-3af6-4fe8-a7d2-e489c18931a2"
–ManagementCertificatePassword $MCPassword
–ManagementCertificatePath "C:\CertificatePath"
–Name "AzureSubscription01"
|
| Add-SCACCloudSystem |
Adds a new connection to a VMM management server or service provider. (Cmdlet)
Parameter Set: SPF
Add-SCACCloudSystem [-Name] <String>
[-ServiceLocation]
<Uri> [-CertificateFilePath] <String>
[-CertificatePassword] <SecureString> -SPF
[-Description <String> ] [ <CommonParameters>]
Parameter Set: VMM
Add-SCACCloudSystem [-Name] <String> [-ServerName]
<String> [-Port] <Int32> -VMM [-Description <String> ]
[ <CommonParameters>]
PS C:\> $Password = ConvertTo-SecureString "PassWord!"
-AsPlainText -Force
PS C:\> Add-SCACCloudsystem
-Name "ServiceProvider01" -ServiceLocation
"https://Server01.contoso.com:8090/SC2012/VMM/
Microsoft.Management.OData.svc/
4deca2d5-6169-49ca-aa7a-efd6e4b372a3"
-CertificateFilePath "\\FileServer01\Certs\TenantCert.pfx"
-CertificatePassword $Password -SPF
|
| Export-SCACAesKey |
Exports the App Controller AES key from the registry to the specified file. (Cmdlet)
Parameter Set: Default
Export-SCACAesKey [-Path] <String> [-Password]
<SecureString> [ <CommonParameters>]
PS C:\>$Password = ConvertTo-SecureString "PassWord!"
-AsPlainText -Force
PS C:\> Export-SCACAESKey
-Path "C:\Keys\Key.txt" -Password $Password
|
| Get-SCACAdminSetting |
Gets one or more administrator settings from the App Controller server. (Cmdlet)
Parameter Set: CEIP
Get-SCACAdminSetting [[-CEIPEnabled]]
[ <CommonParameters>]
Parameter Set: JobHistoryPeriod
Get-SCACAdminSetting [[-JobHistoryPeriodInDays]]
[ <CommonParameters>]
Parameter Set: RefreshInterval
Get-SCACAdminSetting [[-RefreshIntervalInSeconds]]
[ <CommonParameters>]
PS C:\>Get-SCACAdminSetting
PS C:\>Get-SCACAdminSetting -CEIPEnabled
|
| Get-SCACAzureHostedService |
Gets the hosted services on a specified Windows Azure cloud. (Cmdlet)
Parameter Set: Default
Get-SCACAzureHostedService [-Cloud]
<ACAzureSubscriptionCloud> [ <CommonParameters>]
PS C:\> $CloudSystem = Get-SCACCloudSystem -Name
"CloudSystem01.Contoso.com"
PS C:\> $Cloud = Get-SCACCloud -CloudSystem
$CloudSystem
PS C:\> Get-SCACAzureHostedService
-Cloud $Cloud
|
| Get-SCACAzureRoleInstance |
Gets all role instances running in Windows Azure. (Cmdlet)
Get-SCACAzureRoleInstance [ <CommonParameters>]
PS C:\> # The Get-SCACAzureRoleInstance
cmdlet is for internal use only.
|
| Get-SCACAzureServiceDeployment |
Gets a specified Windows Azure service deployment. (Cmdlet)
Parameter Set: Cloud
Get-SCACAzureServiceDeployment [-Cloud] <ACCloud>
[ <CommonParameters>]
Parameter Set: HostedService
Get-SCACAzureServiceDeployment [-HostedService]
<ACAzureHostedService> [[-DeploymentSlot] <String> ]
[ <CommonParameters>]
PS C:\> $CloudSystem = Get-SCACCloudSystem
-Name "CloudSystem01.Contoso.com"
PS C:\> $Cloud = Get-SCACCloud
-CloudSystem $CloudSystem
PS C:\> $HostedService =
@(Get-SCACAzureHostedService -Cloud $Cloud)
PS C:\> Get-SCACAzureServiceDeployment
-HostedService $HostedService[0]
|
| Get-SCACCloud |
Gets one or more App Controller cloud objects. (Cmdlet)
Parameter Set: Default
Get-SCACCloud [[-CloudSystem] <ACCloudSystem> ]
[[-Id] <Guid> ] [ <CommonParameters>]
PS C:\> $CloudSystem = Get-SCACCloudSystem -Name
"CloudSystem01.Contoso.com"
PS C:\> Get-SCACCloud
-CloudSystem $CloudSystem
PS C:\> Get-SCACCloud -Id
"bb4915e4-e4bf-499d-8126-b6e80c63daff"
|
| Get-SCACCloudSystem |
Gets one or more cloud systems on an App Controller server. (Cmdlet)
Parameter Set: Default
Get-SCACCloudSystem [[-Name] <String> ] [ <CommonParameters>]
PS C:\> Get-SCACCloudSystem
PS C:\> Get-SCACCloudSystem -Name "Management.Core.Windows.Net"
|
| Get-SCACJob |
Gets App Controller jobs. (Cmdlet)
Parameter Set: AllJobs
Get-SCACJob [[-All]] [ <CommonParameters>]
Parameter Set: SingleJob
Get-SCACJob [[-Id] <Guid> ] [ <CommonParameters>]
PS C:\> Get-SCACJob -All
PS C:\> Get-SCACJob -ID "bb4915e4-e4bf-499d-8126-b6e80c63daff"
|
| Get-SCACServer |
Gets and establishes a connection with an App Controller server. (Cmdlet)
Parameter Set: Default
Get-SCACServer [-ServerName] <String> [[-Credential]
<PSCredential> ] [[-UserRole] <String> ]
[ <CommonParameters>]
PS C:\> $Credentials = Get-Credential
PS C:\> Get-SCACServer -ServerName
"https://AppControllerSvr01.Contoso.com"
-Credential $Credentials
PS C:\> $Credentials = Get-Credential
PS C:\> $ACServer = Get-SCACServer -ServerName "
https://AppControllerSvr01.Contoso.com"
-Credential $Credentials
PS C:\> $ACServer
PS C:\> $Credentials = Get-Credential
PS C:\> Get-SCACServer -ServerName
"https://AppControllerSvr01.Contoso.com"
-Credential $Credentials -UserRole "UserRole01"
|
| Get-SCACServiceDeployment |
Gets the service deployment for a cloud. (Cmdlet)
Parameter Set: Cloud
Get-SCACServiceDeployment [-Cloud] <ACCloud>
[ <CommonParameters>]
PS C:\> $CloudSystem = Get-SCACCloudSystem
-Name "CloudSystem01.Contoso.com"
PS C:\> $Cloud = Get-SCACCloud -CloudSystem
$CloudSystem
PS C:\> Get-SCACServiceDeployment
-Cloud $Cloud
|
| Get-SCACTemporaryStorage |
Gets the temporary storage used by the App Controller server. (Cmdlet)
Get-SCACTemporaryStorage [ <CommonParameters>]
PS C:\> Get-SCACTemporaryStorage
|
| Get-SCACUserRole |
Gets user roles on the App Controller server. (Cmdlet)
Parameter Set: Managed
Get-SCACUserRole -Managed [ <CommonParameters>]
Parameter Set: MyRoles
Get-SCACUserRole -MyRoles [ <CommonParameters>]
PS C:\> Get-SCACUserRole -Managed
PS C:\> Get-SCACUserRole -MyRoles
|
| Resume-SCACServiceDeployment |
Resumes the specified suspended service deployment. (Cmdlet)
Parameter Set: Default
Resume-SCACServiceDeployment [-ServiceDeployment]
<ACServiceDeployment> [[-RunAsynchronously]]
[ <CommonParameters>]
PS C:\> $CloudSystem = Get-SCACCloudSystem -Name
"CloudSystem01.Contoso.com"
PS C:\> $Cloud = Get-SCACCloud -CloudSystem
$CloudSystem
PS C:\> $SvcDeployment = @(Get-SCACServiceDeployment
-Cloud $Cloud | where { $_.Status -eq "Suspended" })
PS C:\> Resume-SCACServiceDeployment -ServiceDeployment
$SvcDeployment[0] -RunAsynchronously
|
| Set-SCACAdminSetting |
Sets an administrator setting to a specified value. (Cmdlet)
Parameter Set: AdminSettingBySettingObject
Set-SCACAdminSetting [-AdminSetting] <ACAdminSetting>
[-Value] <Int32> [ <CommonParameters>]
Parameter Set: CEIP
Set-SCACAdminSetting [-CEIPEnabled] <Boolean>
[ <CommonParameters>]
Parameter Set: JobHistoryPeriod
Set-SCACAdminSetting [-JobHistoryPeriodInDays]
<Int32> [ <CommonParameters>]
Parameter Set: RefreshInterval
Set-SCACAdminSetting [-RefreshIntervalInSeconds]
<Int32> [ <CommonParameters>]
PS C:\> Set-SCACAdminSetting -JobHistoryPeriodInDays 60
PS C:\> Set-SCACAdminSetting –CEIPEnabled $True
PS C:\> $Setting = Get-SCACAdminSetting
-RefreshIntervalInSeconds
PS C:\> Set-SCACAdminSetting -AdminSetting
$Setting -Value 30
|
| Set-SCACCloudSystem |
Updates the properties of a cloud system. (Cmdlet)
Parameter Set: Default
Set-SCACCloudSystem [-CloudSystem] <ACCloudSystem>
[-CertificateFilePath <String> ] [-Description <String> ]
[-Name <String> ] [ <CommonParameters>]
PS C:\> $CloudSystem = Get-SCACCloudSystem -Name
"CloudSystem01.Contoso.com"
PS C:\> Set-SCACCloudSystem -CloudSystem
$CloudSystem -Name "Test Cloud System"
–Description "This is a test cloud system."
|
| Set-SCACTemporaryStorage |
Sets the temporary storage used by the App Controller server. (Cmdlet)
Parameter Set: SpecifyPath
Set-SCACTemporaryStorage [-Path] <String>
[ <CommonParameters>]
PS C:\> Set-SCACTemporaryStorage -Path "\\ACServer02\ACStorage"
|
| Suspend-SCACServiceDeployment |
Suspends the specified service deployment. (Cmdlet)
Parameter Set: Default
Suspend-SCACServiceDeployment [-ServiceDeployment]
<ACServiceDeployment> [[-RunAsynchronously]]
[ <CommonParameters>]
PS C:\> $CloudSystem = Get-SCACCloudSystem -Name
"CloudSystem01.Contoso.com"
PS C:\> $Cloud = Get-SCACCloud
-CloudSystem $CloudSystem
PS C:\> $SvcDeployment = @(Get-SCACServiceDeployment
-Cloud $Cloud)
PS C:\> Suspend-SCACServiceDeployment
-ServiceDeployment $SvcDeployment[0] -RunAsynchronously
|
