|
| 1 | +# Get-AriaLocalUserAccountLockout |
| 2 | + |
| 3 | +## Synopsis |
| 4 | + |
| 5 | +Retrieves the password account lockout for local users. |
| 6 | + |
| 7 | +## Syntax |
| 8 | + |
| 9 | +```powershell |
| 10 | +Get-AriaLocalUserAccountLockout -vmName <String> -guestUser <String> -guestPassword <String> [-vrni] |
| 11 | + [-product <String>] [-drift] [-version <String>] [-reportPath <String>] [-policyFile <String>] |
| 12 | + [<CommonParameters>] |
| 13 | +``` |
| 14 | + |
| 15 | +## Description |
| 16 | + |
| 17 | +The `Get-AriaLocalUserAccountLockout` cmdlets retrieves the password account lockout for local users. |
| 18 | + |
| 19 | +## Examples |
| 20 | + |
| 21 | +### Example 1 |
| 22 | + |
| 23 | +```powershell |
| 24 | +Get-AriaLocalUserAccountLockout -vmName sfo-vra01 -guestUser root -guestPassword VMw@re1! -product vra |
| 25 | +``` |
| 26 | + |
| 27 | +This example retrieves the VMware Aria Automation account lockout policy. |
| 28 | + |
| 29 | +### Example 2 |
| 30 | + |
| 31 | +```powershell |
| 32 | +Get-AriaLocalUserAccountLockout -vmName sfo-vra01 -guestUser root -guestPassword VMw@re1! -product vra -drift -reportPath "F:\Reporting" -policyFile "passwordPolicyConfig.json" |
| 33 | +``` |
| 34 | + |
| 35 | +This example retrieves the VMware Aria Automation account lockout policy and checks the configuration drift using the provided configuration JSON. |
| 36 | + |
| 37 | +### Example 3 |
| 38 | + |
| 39 | +```powershell |
| 40 | +Get-Get-AriaLocalUserAccountLockout -vmName sfo-vra01 -guestUser root -guestPassword VMw@re1! -product vra -drift |
| 41 | +``` |
| 42 | + |
| 43 | +This example retrieves the VMware Aria Automation account lockout policy and compares the configuration against the product defaults. |
| 44 | + |
| 45 | +## Parameters |
| 46 | + |
| 47 | +### -vmName |
| 48 | + |
| 49 | +The virtual machine name. |
| 50 | + |
| 51 | +```yaml |
| 52 | +Type: String |
| 53 | +Parameter Sets: (All) |
| 54 | +Aliases: |
| 55 | + |
| 56 | +Required: True |
| 57 | +Position: Named |
| 58 | +Default value: None |
| 59 | +Accept pipeline input: False |
| 60 | +Accept wildcard characters: False |
| 61 | +``` |
| 62 | +
|
| 63 | +### -guestUser |
| 64 | +
|
| 65 | +The guest user name. |
| 66 | +
|
| 67 | +```yaml |
| 68 | +Type: String |
| 69 | +Parameter Sets: (All) |
| 70 | +Aliases: |
| 71 | + |
| 72 | +Required: True |
| 73 | +Position: Named |
| 74 | +Default value: None |
| 75 | +Accept pipeline input: False |
| 76 | +Accept wildcard characters: False |
| 77 | +``` |
| 78 | +
|
| 79 | +### -guestPassword |
| 80 | +
|
| 81 | +The guest user password. |
| 82 | +
|
| 83 | +```yaml |
| 84 | +Type: String |
| 85 | +Parameter Sets: (All) |
| 86 | +Aliases: |
| 87 | + |
| 88 | +Required: True |
| 89 | +Position: Named |
| 90 | +Default value: None |
| 91 | +Accept pipeline input: False |
| 92 | +Accept wildcard characters: False |
| 93 | +``` |
| 94 | +
|
| 95 | +### -vrni |
| 96 | +
|
| 97 | +The VMware Ariare Aria Operations for Networks flag. |
| 98 | +
|
| 99 | +```yaml |
| 100 | +Type: SwitchParameter |
| 101 | +Parameter Sets: (All) |
| 102 | +Aliases: |
| 103 | + |
| 104 | +Required: False |
| 105 | +Position: Named |
| 106 | +Default value: False |
| 107 | +Accept pipeline input: False |
| 108 | +Accept wildcard characters: False |
| 109 | +``` |
| 110 | +
|
| 111 | +### -product |
| 112 | +
|
| 113 | +The product to retrieve the password account lockout policy. |
| 114 | +
|
| 115 | +```yaml |
| 116 | +Type: String |
| 117 | +Parameter Sets: (All) |
| 118 | +Aliases: |
| 119 | + |
| 120 | +Required: False |
| 121 | +Position: Named |
| 122 | +Default value: None |
| 123 | +Accept pipeline input: False |
| 124 | +Accept wildcard characters: False |
| 125 | +``` |
| 126 | +
|
| 127 | +### -drift |
| 128 | +
|
| 129 | +The configuration drift flag. |
| 130 | +
|
| 131 | +```yaml |
| 132 | +Type: SwitchParameter |
| 133 | +Parameter Sets: (All) |
| 134 | +Aliases: |
| 135 | + |
| 136 | +Required: False |
| 137 | +Position: Named |
| 138 | +Default value: False |
| 139 | +Accept pipeline input: False |
| 140 | +Accept wildcard characters: False |
| 141 | +``` |
| 142 | +
|
| 143 | +### -version |
| 144 | +
|
| 145 | +The product version. |
| 146 | +
|
| 147 | +```yaml |
| 148 | +Type: String |
| 149 | +Parameter Sets: (All) |
| 150 | +Aliases: |
| 151 | + |
| 152 | +Required: False |
| 153 | +Position: Named |
| 154 | +Default value: None |
| 155 | +Accept pipeline input: False |
| 156 | +Accept wildcard characters: False |
| 157 | +``` |
| 158 | +
|
| 159 | +### -reportPath |
| 160 | +
|
| 161 | +The report path. |
| 162 | +
|
| 163 | +```yaml |
| 164 | +Type: String |
| 165 | +Parameter Sets: (All) |
| 166 | +Aliases: |
| 167 | + |
| 168 | +Required: False |
| 169 | +Position: Named |
| 170 | +Default value: None |
| 171 | +Accept pipeline input: False |
| 172 | +Accept wildcard characters: False |
| 173 | +``` |
| 174 | +
|
| 175 | +### -policyFile |
| 176 | +
|
| 177 | +The policy file. |
| 178 | +
|
| 179 | +```yaml |
| 180 | +Type: String |
| 181 | +Parameter Sets: (All) |
| 182 | +Aliases: |
| 183 | + |
| 184 | +Required: False |
| 185 | +Position: Named |
| 186 | +Default value: None |
| 187 | +Accept pipeline input: False |
| 188 | +Accept wildcard characters: False |
| 189 | +``` |
| 190 | +
|
| 191 | +### Common Parameters |
| 192 | +
|
| 193 | +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). |
0 commit comments