Request-EsxiAccountLockout¶

Synopsis¶

Retrieves the account lockout policy for all ESX hosts in a cluster.

Syntax¶

Request-EsxiAccountLockout -server <String> -user <String> -pass <String> -domain <String> -cluster <String> [-drift] [-reportPath <String>] [-policyFile <String>] [<CommonParameters>]

Description¶

The Request-EsxiAccountLockout cmdlet retrieves a list of ESX hosts for a cluster displaying the currently configured account lockout policy (Advanced Settings Security.AccountLockFailures and Security.AccountUnlockTime). The cmdlet connects to SDDC Manager using the -server, -user, and -pass values:

Validates that network connectivity and authentication is possible to SDDC Manager
Validates that the workload domain exists in the SDDC Manager inventory
Validates that network connectivity and authentication is possible to vCenter
Gathers the ESX hosts for the cluster specified
Retrieves the account lockout policy for all ESX hosts in the cluster

Examples¶

Example 1¶

Request-EsxiAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -cluster [cluster_name]

This example retrieves the account lockout policy for all ESX hosts in the cluster in the workload domain.

Example 2¶

Request-EsxiAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -cluster [cluster_name] -drift -reportPath [report_path] -policyFile [policy_file].json

This example retrieves the account lockout policy for all ESX hosts in the cluster in the workload domain and checks the configuration drift using the provided configuration JSON.

Example 3¶

Request-EsxiAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -cluster [cluster_name] -drift

This example retrieves the account lockout policy for all ESX hosts in the cluster in the workload domain and compares the configuration against the product defaults.

Parameters¶

-server¶

The fully qualified domain name of the SDDC Manager instance.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-user¶

The username to authenticate to the SDDC Manager instance.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-pass¶

The password to authenticate to the SDDC Manager instance.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-domain¶

The name of the workload domain to retrieve the policy from.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-cluster¶

The name of the cluster to retrieve the policy from.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-drift¶

Switch to compare the current configuration against the product defaults or a JSON file.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-reportPath¶

The path to save the policy report.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-policyFile¶

The path to the policy configuration file.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Common Parameters¶

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.