Skip to content

Commit aa9d801

Browse files
bnichmsBrian Nichols
bnichms
and
Brian Nichols
authored
Attestation/WSS Release (Azure#16360)
* HCI Attestation/WSS Release * Updates and fixup * Module check * Update Set help file per comments Co-authored-by: Brian Nichols <[email protected]>
1 parent ebdf315 commit aa9d801

10 files changed

+2511
-23
lines changed

‎src/StackHCI/Az.StackHCI.psd1

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,15 @@ RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.6.1'; })
6969
# NestedModules = @()
7070

7171
# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
72-
FunctionsToExport = 'Register-AzStackHCI', 'Unregister-AzStackHCI',
73-
'Test-AzStackHCIConnection'
72+
FunctionsToExport = 'Register-AzStackHCI',
73+
'Unregister-AzStackHCI',
74+
'Test-AzStackHCIConnection',
75+
'Set-AzStackHCI',
76+
'Enable-AzStackHCIAttestation',
77+
'Disable-AzStackHCIAttestation',
78+
'Add-AzStackHCIVMAttestation',
79+
'Remove-AzStackHCIVMAttestation',
80+
'Get-AzStackHCIVMAttestation'
7481

7582
# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
7683
CmdletsToExport = @()

‎src/StackHCI/Az.StackHCI.psm1

Lines changed: 1538 additions & 21 deletions
Large diffs are not rendered by default.

‎src/StackHCI/ChangeLog.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@
1818
- Additional information about change #1
1919
-->
2020
## Upcoming Release
21+
* Added Support for AzureStack HCI Attestation (Azure Benefits)
22+
- New cmdlets: Enable-AzStackHCIAttestation, Disable-AzStackHCIAttestation, Add-AzStackHCIVMAttestation, Remove-AzStackHCIVMAttestation, Get-AzStackHCIVMAttestation
23+
* Added Support for Windows Server Subscription
24+
- New cmdlet: Set-AzStackHCI
2125

2226
## Version 0.9.1
2327
* Added Support for AzureUSGovernment cloud

‎src/StackHCI/help/Add-AzStackHCIVMAttestation.md

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
---
2+
external help file: Az.StackHCI-help.xml
3+
Module Name: Az.StackHCI
4+
online version: https://docs.microsoft.com/powershell/module/az.stackhci/add-AzStackHCIVMAttestation
5+
schema: 2.0.0
6+
---
7+
8+
# Add-AzStackHCIVMAttestation
9+
10+
## SYNOPSIS
11+
Add-AzStackHCIVMAttestation configures guests for AzureStack HCI IMDS Attestation.
12+
13+
## SYNTAX
14+
15+
### VMName (Default)
16+
```
17+
Add-AzStackHCIVMAttestation [-VMName] <String[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
```
19+
20+
### VMObject
21+
```
22+
Add-AzStackHCIVMAttestation [-VM] <Object[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
23+
```
24+
25+
### AddAll
26+
```
27+
Add-AzStackHCIVMAttestation [-AddAll] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
Add-AzStackHCIVMAttestation configures guests for AzureStack HCI IMDS Attestation.
32+
33+
## EXAMPLES
34+
35+
### EXAMPLE 1
36+
```powershell
37+
C:\PS\>Add-AzStackHCIVMAttestation -AddAll
38+
```
39+
40+
Adding all guests on current node
41+
42+
### EXAMPLE 2
43+
```powershell
44+
C:\PS\>Invoke-Command -ScriptBlock {Add-AzStackHCIVMAttestation -VMName "guest1", "guest2"} -ComputerName "node1"
45+
```
46+
47+
Invoking from the management node/WAC
48+
49+
## PARAMETERS
50+
51+
### -AddAll
52+
Specifies a switch that will add all current guest VMs on host to IMDS Attestation on the current node.
53+
54+
```yaml
55+
Type: System.Management.Automation.SwitchParameter
56+
Parameter Sets: AddAll
57+
Aliases:
58+
59+
Required: True
60+
Position: Named
61+
Default value: False
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -Force
67+
No Confirmation
68+
69+
```yaml
70+
Type: System.Management.Automation.SwitchParameter
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: False
75+
Position: Named
76+
Default value: False
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### -VM
82+
Specifies an array of VM objects from Get-VM.
83+
84+
```yaml
85+
Type: System.Object[]
86+
Parameter Sets: VMObject
87+
Aliases:
88+
89+
Required: True
90+
Position: 1
91+
Default value: None
92+
Accept pipeline input: True (ByValue)
93+
Accept wildcard characters: False
94+
```
95+
96+
### -VMName
97+
Specifies an array of guest VMs to enable.
98+
99+
```yaml
100+
Type: System.String[]
101+
Parameter Sets: VMName
102+
Aliases:
103+
104+
Required: True
105+
Position: 1
106+
Default value: None
107+
Accept pipeline input: True (ByValue)
108+
Accept wildcard characters: False
109+
```
110+
111+
### -Confirm
112+
Prompts you for confirmation before running the cmdlet.
113+
114+
```yaml
115+
Type: System.Management.Automation.SwitchParameter
116+
Parameter Sets: (All)
117+
Aliases: cf
118+
119+
Required: False
120+
Position: Named
121+
Default value: None
122+
Accept pipeline input: False
123+
Accept wildcard characters: False
124+
```
125+
126+
### -WhatIf
127+
Shows what would happen if the cmdlet runs.
128+
The cmdlet is not run.
129+
130+
```yaml
131+
Type: System.Management.Automation.SwitchParameter
132+
Parameter Sets: (All)
133+
Aliases: wi
134+
135+
Required: False
136+
Position: Named
137+
Default value: None
138+
Accept pipeline input: False
139+
Accept wildcard characters: False
140+
```
141+
142+
### CommonParameters
143+
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).
144+
145+
## INPUTS
146+
147+
## OUTPUTS
148+
149+
### PSCustomObject. Returns following Properties in PSCustomObject
150+
### Name: Name of the VM.
151+
### AttestationHost: Host that VM is currently connected.
152+
### Status: Connection status.
153+
## NOTES
154+
155+
## RELATED LINKS

‎src/StackHCI/help/Az.StackHCI.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,27 @@ Locale: en-US
1111
Microsoft Azure PowerShell: Azure Stack HCI registration cmdlets
1212

1313
## Az.StackHCI Cmdlets
14+
### [Add-AzStackHCIVMAttestation](Add-AzStackHCIVMAttestation.md)
15+
Add-AzStackHCIVMAttestation configures guests for AzureStack HCI IMDS Attestation.
16+
17+
### [Disable-AzStackHCIAttestation](Disable-AzStackHCIAttestation.md)
18+
Disable-AzStackHCIAttestation disables IMDS Attestation on the host
19+
20+
### [Enable-AzStackHCIAttestation](Enable-AzStackHCIAttestation.md)
21+
Enable-AzStackHCIAttestation configures the host and enables specified guests for IMDS attestation.
22+
23+
### [Get-AzStackHCIVMAttestation](Get-AzStackHCIVMAttestation.md)
24+
Get-AzStackHCIVMAttestation shows a list of guests added to IMDS Attestation on a node.
25+
1426
### [Register-AzStackHCI](Register-AzStackHCI.md)
1527
Register-AzStackHCI creates a Microsoft.AzureStackHCI cloud resource representing the on-premise cluster and registers the on-premise cluster with Azure.
1628

29+
### [Remove-AzStackHCIVMAttestation](Remove-AzStackHCIVMAttestation.md)
30+
Remove-AzStackHCIVMAttestation removes guests from AzureStack HCI IMDS Attestation.
31+
32+
### [Set-AzStackHCI](Set-AzStackHCI.md)
33+
Set-AzStackHCI modifies resource properties of the Microsoft.AzureStackHCI cloud resource representing the on-premises cluster to enable or disable features.
34+
1735
### [Test-AzStackHCIConnection](Test-AzStackHCIConnection.md)
1836
Test-AzStackHCIConnection verifies connectivity from on-premises clustered nodes to the Azure services required by Azure Stack HCI.
1937

‎src/StackHCI/help/Disable-AzStackHCIAttestation.md

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
---
2+
external help file: Az.StackHCI-help.xml
3+
Module Name: Az.StackHCI
4+
online version: https://docs.microsoft.com/powershell/module/az.stackhci/disable-azstackhciattestation
5+
schema: 2.0.0
6+
---
7+
8+
# Disable-AzStackHCIAttestation
9+
10+
## SYNOPSIS
11+
Disable-AzStackHCIAttestation disables IMDS Attestation on the host
12+
13+
## SYNTAX
14+
15+
```
16+
Disable-AzStackHCIAttestation [[-ComputerName] <String>] [-Credential <PSCredential>] [-RemoveVM] [-Force]
17+
[-WhatIf] [-Confirm] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
Disable-AzStackHCIAttestation disables IMDS Attestation on the host
22+
23+
## EXAMPLES
24+
25+
### EXAMPLE 1
26+
```powershell
27+
C:\PS\>Disable-AzStackHCIAttestation -RemoveVM
28+
```
29+
30+
Remove all guests from IMDS Attestation before disabling on cluster nodes.
31+
32+
### EXAMPLE 2
33+
```powershell
34+
C:\PS\>Disable-AzStackHCIAttestation -ComputerName "host1"
35+
```
36+
37+
## PARAMETERS
38+
39+
### -ComputerName
40+
Specifies the AzureStack HCI host to perform the operation on.
41+
42+
```yaml
43+
Type: System.String
44+
Parameter Sets: (All)
45+
Aliases:
46+
47+
Required: False
48+
Position: 1
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### -Credential
55+
Specifies the credential for the ComputerName.
56+
Default is the current user executing the Cmdlet.
57+
58+
```yaml
59+
Type: System.Management.Automation.PSCredential
60+
Parameter Sets: (All)
61+
Aliases:
62+
63+
Required: False
64+
Position: Named
65+
Default value: [System.Management.Automation.PSCredential]::Empty
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### -Force
71+
No confirmation.
72+
73+
```yaml
74+
Type: System.Management.Automation.SwitchParameter
75+
Parameter Sets: (All)
76+
Aliases:
77+
78+
Required: False
79+
Position: Named
80+
Default value: False
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
85+
### -RemoveVM
86+
Specifies the guests on each node should be removed from IMDS Attestation before disabling on cluster.
87+
Disable cannot continue before guests are removed.
88+
89+
```yaml
90+
Type: System.Management.Automation.SwitchParameter
91+
Parameter Sets: (All)
92+
Aliases:
93+
94+
Required: False
95+
Position: Named
96+
Default value: False
97+
Accept pipeline input: False
98+
Accept wildcard characters: False
99+
```
100+
101+
### -Confirm
102+
Prompts you for confirmation before running the cmdlet.
103+
104+
```yaml
105+
Type: System.Management.Automation.SwitchParameter
106+
Parameter Sets: (All)
107+
Aliases: cf
108+
109+
Required: False
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: False
113+
Accept wildcard characters: False
114+
```
115+
116+
### -WhatIf
117+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
118+
119+
```yaml
120+
Type: System.Management.Automation.SwitchParameter
121+
Parameter Sets: (All)
122+
Aliases: wi
123+
124+
Required: False
125+
Position: Named
126+
Default value: None
127+
Accept pipeline input: False
128+
Accept wildcard characters: False
129+
```
130+
131+
### CommonParameters
132+
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).
133+
134+
## INPUTS
135+
136+
## OUTPUTS
137+
138+
### PSCustomObject. Returns following Properties in PSCustomObject
139+
### Cluster: Name of cluster
140+
### Node: Name of the host.
141+
### Attestation: IMDS Attestation status.
142+
## NOTES
143+
144+
## RELATED LINKS

0 commit comments

Comments
 (0)