PowerShell Module for VMware Cloud Foundation Password Management

Overview

VMware.CloudFoundation.PasswordManagement is a PowerShell module that has been written to support the ability to report and configure the password policy settings across your VMware Cloud Foundation instance.

With these cmdlets, you can:

• Generate a password policy report for your SDDC Manager instance.
• Generate a password policy report with configuration drift for your SDDC Manager instance by using a password policy configuration file.
• Configure password polices for your SDDC Manager instance by using a password policy configuration file.

The module provides coverage for the following components:

• vCenter Single Sign-On
• vCenter Server
• NSX Local Manager
• NSX Edge
• SDDC Manager
• Standalone Workspace ONE Access

Requirements

Platforms

• VMware Cloud Foundation 4.3 or later

Operating Systems

• Microsoft Windows Server 2019 and 2022
• Microsoft Windows 10 and 11
• VMware Photon OS 3.0 and 4.0

PowerShell Editions and Versions

PowerShell Modules

Installing the Module

Verify that your system has a supported edition and version of PowerShell installed.

Install the supporting PowerShell modules from the Microsoft PowerShell Gallery by running the following commands in the PowerShell console:

Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
Install-Module -Name VMware.PowerCLI -MinimumVersion 13.0.0
Install-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9
Install-Module -Name PowerVCF -MinimumVersion 2.3.0
Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.2.0
Install-Module -Name VMware.CloudFoundation.PasswordManagement

If using PowerShell Core, import the modules by running the following commands in the PowerShell console before proceeding:

Import-Module -Name VMware.PowerCLI
Import-Module -Name VMware.vSphere.SsoAdmin
Import-Module -Name PowerVCF
Import-Module -Name PowerValidatedSolutions
Import-Module -Name VMware.CloudFoundation.PasswordManagement

Verifying the Module

To verify the correct versions of the supporting modules are installed, run the following command in the PowerShell console.

Test-VcfPasswordManagementPrereq

Once installed, any cmdlets associated with VMware.CloudFoundation.PasswordManagement and the supporting PowerShell modules will be available for use.

Updating the Module

Update the PowerShell module to the latest release from the Microsoft PowerShell Gallery by running the following command in the PowerShell console:

Update-Module -Name VMware.CloudFoundation.PasswordManagement

To verify the version of the PowerShell module, run the following command in the PowerShell console.

Get-InstalledModule -Name VMware.CloudFoundation.PasswordManagement

Getting Help

To view the cmdlets available in the module, run the following command in the PowerShell console.

Get-Command -Module VMware.CloudFoundation.PasswordManagement

To view the help for any cmdlet, run the Get-Help command in the PowerShell console.

For example:

Get-Help -Name Invoke-PasswordPolicyManager

Get-Help -Name Invoke-PasswordPolicyManager -examples

Get-Help -Name Invoke-PasswordPolicyManager -full

User Access

Each cmdlet may provide one or more usage examples. Many of the cmdlets require that credentials are provided to output to the PowerShell console or a report.

The cmdlets in this module, and its dependencies, return data from multiple platform components. The credentials for most of the platform components are returned to the cmdlets by retrieving credentials from the SDDC Manager inventory and using these credentials, as needed, within cmdlet operations.

For the best experience, for cmdlets that connect to SDDC Manager, use the VMware Cloud Foundation API user admin@local or an account with the ADMIN role in SDDC Manager (e.g., [email protected]).

Contributing

The project team welcomes contributions from the community. Please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.

For more detailed information, refer to the contribution guidelines to get started.

Support

This PowerShell module is not supported by VMware Support.

We welcome you to use the GitHub issues tracker to report bugs or suggest features and enhancements.

When filing an issue, please check existing open, or recently closed, issues to make sure someone else hasn't already reported the issue.

Please try to include as much information as you can. Details like these are incredibly useful:

• A reproducible test case or series of steps.
• Any modifications you've made relevant to the bug.
• Anything unusual about your environment or deployment.

License

Copyright 2023 VMware, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.