├── .ci └── pester.tests.ps1 ├── .github ├── ISSUE_TEMPLATE │ ├── bug.yml │ ├── config.yml │ ├── docs.yml │ └── enhancement.yml ├── dependabot.yml ├── icon-400px.png ├── icon-400px.svg ├── icon-85px.svg ├── labeler-issues.yml ├── labeler-pull-requests.yml ├── pull_request_template.md └── workflows │ ├── docs.yml │ ├── issues.yml │ ├── lock-threads.yml │ ├── pull-requests.yml │ ├── release.yml │ ├── stale.yml │ └── tests.yml ├── .gitignore ├── .vscode ├── extensions.json └── settings.json ├── CHANGELOG.md ├── CODEOWNERS ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── Makefile ├── NOTICE ├── README.md ├── VMware.CloudFoundation.PasswordManagement.psd1 ├── VMware.CloudFoundation.PasswordManagement.psm1 ├── docs ├── assets │ ├── images │ │ ├── icon-color.svg │ │ └── icon-white.svg │ └── stylesheets │ │ └── extra.css ├── community │ ├── code-of-conduct.md │ ├── contributing.md │ ├── index.md │ └── support.md ├── documentation │ ├── functions │ │ ├── Get-PasswordPolicyDefault.md │ │ ├── Invoke-PasswordPolicyManager.md │ │ ├── Invoke-PasswordRotationManager.md │ │ ├── Publish-AriaLocalUserPasswordPolicy.md │ │ ├── Publish-EsxiPasswordPolicy.md │ │ ├── Publish-NsxEdgeAccountLockout.md │ │ ├── Publish-NsxEdgePasswordComplexity.md │ │ ├── Publish-NsxEdgePasswordExpiration.md │ │ ├── Publish-NsxManagerAccountLockout.md │ │ ├── Publish-NsxManagerPasswordComplexity.md │ │ ├── Publish-NsxManagerPasswordExpiration.md │ │ ├── Publish-PasswordRotationPolicy.md │ │ ├── Publish-SddcManagerAccountLockout.md │ │ ├── Publish-SddcManagerPasswordComplexity.md │ │ ├── Publish-SddcManagerPasswordExpiration.md │ │ ├── Publish-SsoPasswordPolicy.md │ │ ├── Publish-VcenterLocalAccountLockout.md │ │ ├── Publish-VcenterLocalPasswordComplexity.md │ │ ├── Publish-VcenterLocalPasswordExpiration.md │ │ ├── Publish-VcenterPasswordExpiration.md │ │ ├── Publish-WsaDirectoryPasswordPolicy.md │ │ ├── Publish-WsaLocalPasswordPolicy.md │ │ ├── Request-AriaLocalUserAccountLockout.md │ │ ├── Request-AriaLocalUserPasswordComplexity.md │ │ ├── Request-AriaLocalUserPasswordExpiration.md │ │ ├── Request-EsxiAccountLockout.md │ │ ├── Request-EsxiPasswordComplexity.md │ │ ├── Request-EsxiPasswordExpiration.md │ │ ├── Request-LocalUserPasswordExpiration.md │ │ ├── Request-NsxtEdgeAccountLockout.md │ │ ├── Request-NsxtEdgePasswordComplexity.md │ │ ├── Request-NsxtEdgePasswordExpiration.md │ │ ├── Request-NsxtManagerAccountLockout.md │ │ ├── Request-NsxtManagerPasswordComplexity.md │ │ ├── Request-NsxtManagerPasswordExpiration.md │ │ ├── Request-PasswordRotationPolicy.md │ │ ├── Request-SddcManagerAccountLockout.md │ │ ├── Request-SddcManagerPasswordComplexity.md │ │ ├── Request-SddcManagerPasswordExpiration.md │ │ ├── Request-SsoAccountLockout.md │ │ ├── Request-SsoPasswordComplexity.md │ │ ├── Request-SsoPasswordExpiration.md │ │ ├── Request-VcenterAccountLockout.md │ │ ├── Request-VcenterPasswordComplexity.md │ │ ├── Request-VcenterPasswordExpiration.md │ │ ├── Request-VcenterRootPasswordExpiration.md │ │ ├── Request-WsaAccountLockout.md │ │ ├── Request-WsaLocalUserAccountLockout.md │ │ ├── Request-WsaLocalUserPasswordComplexity.md │ │ ├── Request-WsaPasswordComplexity.md │ │ ├── Request-WsaPasswordExpiration.md │ │ ├── Start-PasswordPolicyConfig.md │ │ ├── Test-VcfPasswordManagementPrereq.md │ │ ├── Update-AriaLocalUserPasswordAccountLockout.md │ │ ├── Update-AriaLocalUserPasswordComplexity.md │ │ ├── Update-AriaLocalUserPasswordExpiration.md │ │ ├── Update-EsxiAccountLockout.md │ │ ├── Update-EsxiPasswordComplexity.md │ │ ├── Update-EsxiPasswordExpiration.md │ │ ├── Update-LocalUserPasswordExpiration.md │ │ ├── Update-NsxtEdgeAccountLockout.md │ │ ├── Update-NsxtEdgePasswordComplexity.md │ │ ├── Update-NsxtEdgePasswordExpiration.md │ │ ├── Update-NsxtManagerAccountLockout.md │ │ ├── Update-NsxtManagerPasswordComplexity.md │ │ ├── Update-NsxtManagerPasswordExpiration.md │ │ ├── Update-PasswordRotationPolicy.md │ │ ├── Update-SddcManagerAccountLockout.md │ │ ├── Update-SddcManagerPasswordComplexity.md │ │ ├── Update-SddcManagerPasswordExpiration.md │ │ ├── Update-SsoAccountLockout.md │ │ ├── Update-SsoPasswordComplexity.md │ │ ├── Update-SsoPasswordExpiration.md │ │ ├── Update-VcenterAccountLockout.md │ │ ├── Update-VcenterPasswordComplexity.md │ │ ├── Update-VcenterPasswordExpiration.md │ │ ├── Update-VcenterRootPasswordExpiration.md │ │ ├── Update-WsaAccountLockout.md │ │ ├── Update-WsaLocalUserAccountLockout.md │ │ ├── Update-WsaLocalUserPasswordComplexity.md │ │ ├── Update-WsaPasswordComplexity.md │ │ └── Update-WsaPasswordExpiration.md │ ├── index.md │ └── testing │ │ └── index.md ├── favicon.ico ├── index.md ├── install.md ├── license.md ├── release-notes.md ├── requirements.txt ├── snippets │ ├── aria-parameters.md │ ├── copy-module-local-linux.sh │ ├── copy-module-local-windows.ps1 │ ├── import-module-local-linux.ps1 │ ├── import-module-tests.ps1 │ ├── import-module.ps1 │ ├── install-module.ps1 │ ├── installed-module.ps1 │ ├── pre-req-linux.sh │ ├── save-module-local-linux.ps1 │ ├── save-module-local-windows.ps1 │ ├── update-module.ps1 │ └── update-modules.ps1 ├── update.md └── user-access.md ├── mkdocs.yml └── tests ├── PPM.Tests.ps1 ├── inputData.json.example └── logs └── .gitkeep /.ci/pester.tests.ps1: -------------------------------------------------------------------------------- 1 | Describe -Tag:('ModuleValidation') 'Module Basic Tests' { 2 | 3 | It 'is present' { 4 | $module = Get-Module -Name $moduleName 5 | $module | Should -Be $true 6 | } 7 | 8 | It ('passes Test-ModuleManifest') { 9 | Test-ModuleManifest -Path $moduleManifest | Should -Not -BeNullOrEmpty 10 | $? | Should -Be $true 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: Module Documentation 4 | url: 'https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-password-management' 5 | about: Having trouble with the module? Check out the documentation. 6 | - name: VMware Cloud Foundation Product Documentation 7 | url: https://docs.vmware.com/en/VMware-Cloud-Foundation/ 8 | about: Efficiently manage virtual machine and container workloads. Deliver cloud benefits to on-premises, full-stack hyperconverged infrastructure deployments. 9 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/docs.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Documentation 3 | description: Found a typo or something that needs clarification? 4 | title: 'Please add a short description.' 5 | labels: ["documentation", "needs-review"] 6 | projects: ["vmware/22"] 7 | body: 8 | - type: markdown 9 | attributes: 10 | value: > 11 | When filing a documentation issue, please include the following information. 12 | - type: checkboxes 13 | id: terms 14 | attributes: 15 | label: Code of Conduct 16 | description: >- 17 | This project has a [Code of Conduct](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/blob/main/CODE_OF_CONDUCT.md) 18 | that all participants are expected to understand and follow. 19 | options: 20 | - label: I have read and agree to the project's Code of Conduct. 21 | required: true 22 | - type: input 23 | id: version-module 24 | attributes: 25 | label: Module Version 26 | description: Please provide the module version. 27 | validations: 28 | required: true 29 | - type: textarea 30 | id: motivation 31 | attributes: 32 | label: Motivation 33 | description: Why should we update our docs or examples? 34 | validations: 35 | required: false 36 | - type: textarea 37 | id: suggestion 38 | attributes: 39 | label: Suggestion 40 | description: What should we do instead? 41 | validations: 42 | required: false 43 | - type: markdown 44 | attributes: 45 | value: "### Community Note\n* Please vote on this issue by adding a \U0001F44D [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request\n* Please do not leave \"+1\" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request\n* If you are interested in working on this issue or have submitted a pull request, please leave a comment\n" 46 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/enhancement.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Enhancement Request 3 | description: Is something critical missing? Suggest an enhancement. 4 | title: 'Please add a short description.' 5 | labels: ["enhancement", "needs-review"] 6 | projects: ["vmware/22"] 7 | body: 8 | - type: markdown 9 | attributes: 10 | value: > 11 | Before filing an enhancement, please search the existing issues and use the 12 | [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) 13 | feature to add up-votes to existing requests. 14 | 15 | 16 | When filing an enhancement, please include the following information. 17 | - type: checkboxes 18 | id: terms 19 | attributes: 20 | label: Code of Conduct 21 | description: >- 22 | This project has a [Code of 23 | Conduct](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/blob/main/CODE_OF_CONDUCT.md) 24 | that all participants are expected to understand and follow. 25 | options: 26 | - label: I have read and agree to the project's Code of Conduct. 27 | required: true 28 | - label: Vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue initial description to help the maintainers prioritize. 29 | required: false 30 | - label: Do not leave "+1" or other comments that do not add relevant information or questions. 31 | required: false 32 | - label: If you are interested in working on this issue or have submitted a pull request, please leave a comment. 33 | required: false 34 | - type: textarea 35 | id: description 36 | attributes: 37 | label: Description 38 | description: A written overview of the enhancement. 39 | validations: 40 | required: true 41 | - type: textarea 42 | id: use-case 43 | attributes: 44 | label: Use Case(s) 45 | description: Any relevant use-cases that you see. 46 | validations: 47 | required: true 48 | - type: textarea 49 | id: potential-configuration 50 | attributes: 51 | label: Potential Configuration 52 | description: Provide a potential configuration. 53 | validations: 54 | required: true 55 | - type: textarea 56 | id: references 57 | attributes: 58 | label: References 59 | description: Provide any references. 60 | validations: 61 | required: false 62 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | --- 2 | version: 2 3 | 4 | updates: 5 | - package-ecosystem: github-actions 6 | target-branch: develop 7 | directory: / 8 | schedule: 9 | interval: weekly 10 | labels: 11 | - chore 12 | - github-actions 13 | commit-message: 14 | prefix: 'chore(gh):' 15 | 16 | - package-ecosystem: pip 17 | target-branch: develop 18 | directory: / 19 | schedule: 20 | interval: weekly 21 | labels: 22 | - chore 23 | - dependencies 24 | commit-message: 25 | prefix: 'chore(gh):' 26 | -------------------------------------------------------------------------------- /.github/icon-400px.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/71f1331758d40cdff7de7078c68d539820017ad0/.github/icon-400px.png -------------------------------------------------------------------------------- /.github/icon-400px.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.github/icon-85px.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /.github/labeler-issues.yml: -------------------------------------------------------------------------------- 1 | --- 2 | pending-review: 3 | - '.*' 4 | -------------------------------------------------------------------------------- /.github/labeler-pull-requests.yml: -------------------------------------------------------------------------------- 1 | --- 2 | chore: 3 | - changed-files: 4 | - any-glob-to-any-file: 5 | - ".ci/**/*" 6 | - ".github/**/*" 7 | - ".gitignore" 8 | documentation: 9 | - changed-files: 10 | - any-glob-to-any-file: 11 | - "**/*.md" 12 | - "Makefile" 13 | - "**/*.md" 14 | - "mkdocs.yml" 15 | github-actions: 16 | - changed-files: 17 | - any-glob-to-any-file: 18 | - ".github/workflows/**/*" 19 | needs-review: 20 | - changed-files: 21 | - any-glob-to-any-file: 22 | - "**" 23 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 11 | 12 | ### Summary 13 | 14 | 17 | 18 | ### Type 19 | 20 | 23 | 24 | - [ ] Bugfix 25 | - [ ] Enhancement or Feature 26 | - [ ] Code Style or Formatting 27 | - [ ] Documentation 28 | - [ ] Refactoring 29 | - [ ] Chore 30 | - [ ] Other 31 | Please describe: 32 | 33 | ### Breaking Changes? 34 | 35 | 39 | 40 | - [ ] Yes, there are breaking changes. 41 | - [ ] No, there are no breaking changes. 42 | 43 | ### Test and Documentation 44 | 45 | 49 | 50 | - [ ] Tests have been completed. 51 | - [ ] Documentation has been added or updated. 52 | 53 | 56 | 57 | ### Issue References 58 | 59 | 72 | 73 | ### Additional Information 74 | 75 | 78 | -------------------------------------------------------------------------------- /.github/workflows/docs.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Publish Documentation 3 | 4 | on: 5 | workflow_dispatch: 6 | 7 | jobs: 8 | publish-docs: 9 | runs-on: ubuntu-latest 10 | permissions: 11 | contents: write 12 | steps: 13 | - name: Checkout Repository 14 | uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 15 | with: 16 | fetch-depth: 0 17 | - name: Setup Python 18 | uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 19 | with: 20 | python-version: 3.x 21 | - name: Install Dependencies 22 | run: | 23 | pip install mkdocs-material 24 | pip install --requirement docs/requirements.txt 25 | - name: Publish Documentation 26 | run: | 27 | mkdocs gh-deploy --force 28 | if: ${{ success() }} 29 | -------------------------------------------------------------------------------- /.github/workflows/issues.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Issue Labels 3 | 4 | on: 5 | issues: 6 | types: 7 | - opened 8 | 9 | jobs: 10 | label-issues: 11 | runs-on: ubuntu-latest 12 | permissions: 13 | contents: read 14 | issues: write 15 | steps: 16 | - name: Apply Labels 17 | uses: github/issue-labeler@c1b0f9f52a63158c4adc09425e858e87b32e9685 # v3.4 18 | with: 19 | repo-token: ${{ secrets.GITHUB_TOKEN }} 20 | configuration-path: .github/labeler-issues.yml 21 | enable-versioned-regex: 0 22 | include-title: 1 23 | -------------------------------------------------------------------------------- /.github/workflows/lock-threads.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Lock Threads 3 | 4 | on: 5 | schedule: 6 | - cron: 30 00 * * * 7 | 8 | jobs: 9 | lock: 10 | runs-on: ubuntu-latest 11 | permissions: 12 | issues: write 13 | pull-requests: write 14 | steps: 15 | - uses: dessant/lock-threads@1bf7ec25051fe7c00bdd17e6a7cf3d7bfb7dc771 # v5.0.1 16 | with: 17 | github-token: ${{ secrets.GITHUB_TOKEN }} 18 | issue-comment: > 19 | I'm going to lock this issue because it has been closed for 30 20 | days. This helps our maintainers find and focus on the active 21 | issues. 22 | 23 | 24 | If you have found a problem that seems similar to this, 25 | please open a new issue and complete the issue template so we can 26 | capture all the details necessary to investigate further. 27 | issue-inactive-days: 30 28 | pr-comment: > 29 | I'm going to lock this pull request because it has been closed for 30 | 30 days. This helps our maintainers find and focus on the active 31 | issues. 32 | 33 | 34 | If you have found a problem that seems related to this 35 | change, please open a new issue and complete the issue template so 36 | we can capture all the details necessary to investigate further. 37 | pr-inactive-days: 30 38 | -------------------------------------------------------------------------------- /.github/workflows/pull-requests.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Pull Request Labels 3 | 4 | on: 5 | pull_request_target: 6 | branches: 7 | - develop 8 | types: 9 | - opened 10 | - synchronize 11 | - reopened 12 | - edited 13 | - ready_for_review 14 | 15 | jobs: 16 | labeler: 17 | name: Labeler 18 | runs-on: ubuntu-latest 19 | permissions: 20 | contents: read 21 | pull-requests: write 22 | steps: 23 | - name: Apply Labels 24 | uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0 25 | with: 26 | repo-token: ${{ secrets.GITHUB_TOKEN }} 27 | configuration-path: .github/labeler-pull-requests.yml 28 | 29 | -------------------------------------------------------------------------------- /.github/workflows/stale.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Stale 3 | 4 | on: 5 | schedule: 6 | - cron: 00 00 * * * 7 | 8 | jobs: 9 | stale: 10 | runs-on: ubuntu-latest 11 | permissions: 12 | contents: read 13 | issues: write 14 | pull-requests: write 15 | steps: 16 | - uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0 17 | with: 18 | repo-token: ${{ secrets.GITHUB_TOKEN }} 19 | days-before-stale: 60 20 | days-before-close: 30 21 | exempt-issue-labels: needs-triage 22 | exempt-pr-labels: needs-review 23 | exempt-all-assignees: true 24 | remove-stale-when-updated: true 25 | delete-branch: false 26 | stale-issue-label: stale 27 | stale-issue-message: > 28 | Marking this issue as stale due to inactivity. This helps us focus 29 | on the active issues. If this issue receives no comments in the next 30 | 30 days it will automatically be closed. 31 | 32 | 33 | If this issue was automatically closed and you feel this issue 34 | should be reopened, we encourage creating a new issue linking back 35 | to this one for added context. 36 | stale-pr-label: stale 37 | stale-pr-message: > 38 | Marking this pull request as stale due to inactivity. This helps us 39 | focus on the active pull requests. If this pull request receives no 40 | comments in the next 30 days it will automatically be closed. 41 | 42 | 43 | If this pull request was automatically closed and you feel this pull 44 | request should be reopened, we encourage creating a new pull request 45 | linking back to this one for added context. 46 | -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Test 3 | 4 | on: 5 | push: 6 | branches: [develop] 7 | paths: 8 | - "**.psm1" 9 | - "**.psd1" 10 | workflow_dispatch: 11 | 12 | jobs: 13 | basic_tests: 14 | runs-on: ubuntu-latest 15 | permissions: 16 | contents: read 17 | steps: 18 | - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 19 | - name: Run Basic Tests 20 | working-directory: ${{ github.workspace }} 21 | shell: pwsh 22 | run: | 23 | Write-Output "INFO: Setting PowerShell Gallery as a trusted repository." 24 | Set-PSRepository psgallery -InstallationPolicy trusted 25 | Write-Output "INFO: Installing module 'VMware.vSphere.SsoAdmin' from PSGallery." 26 | Install-Module -Name VMware.vSphere.SsoAdmin -confirm:$false -Force 27 | Write-Output "INFO: Installing module 'VMware.PowerCLI' from PSGallery." 28 | Install-Module -Name VMware.PowerCLI -confirm:$false -Force 29 | $moduleManifest = (Get-ChildItem -Path $env:GITHUB_WORKSPACE -Filter *.psd1).Name 30 | if ($moduleManifest) { 31 | Write-Output "SUCCESS: Manifest '$moduleManifest' found in '$env:GITHUB_WORKSPACE'." 32 | } else { 33 | Write-Output "FAILURE: Manifest not found in '$env:GITHUB_WORKSPACE'." 34 | } 35 | if ($moduleManifest -match '^(.*)\.psd1$') { 36 | $moduleName = $Matches[1] 37 | Write-Output "SUCCESS: Determining module name from manifest'$moduleManifest'." 38 | } else { 39 | Write-Error "FAILED: Determining module name from manifest '$moduleManifest'." 40 | } 41 | Write-Output "INFO: Reading module manifest '$moduleManifest'." 42 | $moduleManifestData = Import-PowerShellDataFile -Path $moduleManifest 43 | $requiredModules = $moduleManifestData.RequiredModules 44 | $requiredModules = $requiredModules | Where-Object { $_.ModuleName -ne 'VMware.vSphere.SsoAdmin' -and $_.ModuleName -ne 'VMware.PowerCLI'} 45 | Write-Output "INFO: Required modules are $($requiredModules.ModuleName -join ', ')." 46 | foreach ($module in $requiredModules) { 47 | $requiredModuleName = $module.ModuleName 48 | $licenseUri = [System.Uri] (Find-Module -Name $requiredModuleName).LicenseUri 49 | $gitUri = $licenseUri.AbsoluteUri.Split('/blob/')[0].TrimEnd('/') -replace '\.git$' 50 | $requiredModuleFolder = Join-Path -Path $PSScriptRoot -ChildPath "dependencies/$requiredModuleName" 51 | if (-not (Test-Path -Path $requiredModuleFolder -PathType Container)) { 52 | Write-Output "INFO: Cloning module '$requiredModuleName' from '$gitUri' to '$requiredModuleFolder'." 53 | git clone $gitUri $requiredModuleFolder | Out-Null 54 | if (Test-Path -Path $requiredModuleFolder -PathType Container) { 55 | Write-Output "SUCCESS: Module '$requiredModuleName' was cloned." 56 | } else { 57 | Write-Error "FAILED: Module '$requiredModuleName' was not cloned." 58 | } 59 | } 60 | Write-Output "INFO: Importing module '$requiredModuleName' from '$requiredModuleFolder'." 61 | Import-Module -Name (Join-Path -Path $requiredModuleFolder -ChildPath "$requiredModuleName.psd1") -Force 62 | if (Get-Module -Name $requiredModuleName) { 63 | Write-Output "SUCCESS: Module '$requiredModuleName' was imported." 64 | } else { 65 | Write-Error "FAILED: Module '$requiredModuleName' was not imported." 66 | } 67 | } 68 | Write-Output "INFO: Importing module '$moduleName' from '$moduleManifest'." 69 | Import-Module -Name (Resolve-Path $moduleManifest).Path -Force -ErrorAction Stop 70 | if (Get-Module -Name $moduleName) { 71 | Write-Output "SUCCESS: Module '$moduleName' was imported." 72 | } else { 73 | Write-Error "FAILED: Module '$moduleName' was not imported." 74 | } 75 | Write-Output "INFO: Installing module 'Pester' from PSGallery." 76 | Install-Module -Name Pester -confirm:$false -Force 77 | Write-Output "INFO: Invoking Pester tests." 78 | Invoke-Pester -Path "./.ci/pester.tests.ps1" -Output Detailed -PassThru 79 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # MacOS 2 | ## Ignore desktop services files. 3 | **/.DS_Store 4 | 5 | # Pester 6 | ## Ignore logs directory. 7 | **/tests/logs/*.log 8 | 9 | # MkDocs 10 | ## Ignore site directory. 11 | **/.site/** 12 | -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "vscode.json-language-features", // JSON 4 | "davidanson.vscode-markdownlint", // Markdown Lint 5 | "eamodio.gitlens", // GitLens 6 | "esbenp.prettier-vscode", // Prettier 7 | "marvhen.reflow-markdown", // Reflow Markdown 8 | "ms-vscode.powershell", // PowerShell 9 | "trunk.io" // Trunk 10 | ] 11 | } 12 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "[json]": { 3 | "editor.defaultFormatter": "vscode.json-language-features", 4 | "editor.formatOnPaste": true, 5 | "editor.formatOnSave": true, 6 | "editor.formatOnType": true, 7 | "editor.trimAutoWhitespace": true 8 | }, 9 | "[md]": { 10 | "editor.defaultFormatter": "DavidAnson.vscode-markdownlint", 11 | "editor.formatOnPaste": true, 12 | "editor.formatOnSave": true, 13 | "editor.formatOnType": true, 14 | "editor.trimAutoWhitespace": true, 15 | "editor.wordWrap": "bounded", 16 | "editor.wordWrapColumn": 100, 17 | "editor.rulers": [100], 18 | }, 19 | "[powershell]": { 20 | "editor.defaultFormatter": "ms-vscode.powershell", 21 | "editor.formatOnPaste": true, 22 | "editor.formatOnSave": true, 23 | "editor.formatOnType": true, 24 | "editor.trimAutoWhitespace": true, 25 | "editor.wordWrap": "off" 26 | }, 27 | "editor.bracketPairColorization.enabled": true, 28 | "editor.bracketPairColorization.independentColorPoolPerBracketType": true, 29 | "editor.defaultFormatter": "esbenp.prettier-vscode", 30 | "editor.formatOnSaveMode": "modificationsIfAvailable", 31 | "editor.guides.bracketPairs": true, 32 | "files.insertFinalNewline": true, 33 | "files.trimTrailingWhitespace": true, 34 | "files.watcherExclude": { 35 | "**/.DS_Store": true, 36 | "**/.site/**": true, 37 | "**/.trunk/**": true 38 | }, 39 | "powershell.analyzeOpenDocumentsOnly": true, 40 | "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationAfterEveryPipeline", 41 | "powershell.codeFormatting.preset": "OTBS", 42 | "powershell.codeFormatting.trimWhitespaceAroundPipe": true, 43 | "powershell.codeFormatting.whitespaceBetweenParameters": true, 44 | "powershell.integratedConsole.suppressStartupBanner": true, 45 | "powershell.scriptAnalysis.enable": true, 46 | "extensions.ignoreRecommendations": false, 47 | "reflowMarkdown.preferredLineLength": 100, 48 | "reflowMarkdown.wrapLongLinks": "doNotWrap", 49 | } 50 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @vmware/powershell-module-for-vmware-cloud-foundation-password-management-maintainers 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | BSD 2-Clause License 2 | 3 | © Broadcom. All Rights Reserved. 4 | The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. 5 | 6 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the 7 | following conditions are met: 8 | 9 | 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the 10 | following disclaimer. 11 | 12 | 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the 13 | following disclaimer in the documentation and/or other materials provided with the distribution. 14 | 15 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 16 | INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 17 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 18 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 19 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 20 | WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 21 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 22 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # © Broadcom. All Rights Reserved. 2 | # The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. 3 | # SPDX-License-Identifier: BSD-2 4 | 5 | docs-install: 6 | pip install mkdocs-material 7 | pip install --requirement docs/requirements.txt 8 | 9 | docs-serve: 10 | mkdocs serve 11 | 12 | docs-serve-live: 13 | mkdocs serve --livereload -w ./ 14 | 15 | docs-build: 16 | mkdocs build 17 | 18 | docs-uninstall: 19 | pip uninstall mkdocs-material mkdocs -y 20 | pip uninstall --requirement docs/requirements.txt -y 21 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | © Broadcom. All Rights Reserved. 2 | The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. 3 | 4 | This product is licensed to you under the BSD 2 clause (the "License"). You may not use this product except in compliance with the License. 5 | 6 | This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file. 7 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | A PowerShell Module for Cloud Foundation Password Management

4 | 5 | # PowerShell Module for VMware Cloud Foundation Password Management 6 | 7 | [Documentation][docs-module]   8 | [CHANGELOG][changelog] 9 | 10 | [PowerShell Gallery][psgallery-module]   11 | PowerShell Gallery Downloads 12 | 13 | ## Overview 14 | 15 | `VMware.CloudFoundation.PasswordManagement` is a PowerShell module designed to help you report on 16 | and manage password policy settings within your VMware Cloud Foundation environment. 17 | 18 | Using this module, you can perform various tasks on a VMware Cloud Foundation instance or a specific 19 | workload domain. 20 | 21 | - Generate detailed password policy reports, including information on password expiration, 22 | complexity, and account lockout settings. 23 | - Identify configuration drift by generating password policy reports using a predefined configuration file. 24 | - Update password policies seamlessly using a password policy configuration file. 25 | - Create comprehensive password rotation reports for all accounts managed by SDDC Manager. 26 | 27 | ## Documentation 28 | 29 | For detailed instructions on using this module, refer to the [official documentation][docs-module]. 30 | 31 | ## Contributing 32 | 33 | We encourage community contributions! To get started, please refer to the [contribution guidelines][contributing]. 34 | 35 | ## Support 36 | 37 | This module is community-driven and maintained by the project contributors. It is not officially 38 | supported by Broadcom Support but thrives on collaboration and input from its users. 39 | 40 | Use the GitHub [issues][gh-issues] to report bugs or suggest features and enhancements. Issues are 41 | monitored by the maintainers and are prioritized based on criticality and community [reactions][gh-reactions]. 42 | 43 | Before filing an issue, please search the issues and use the reactions feature to add votes to 44 | matching issues. Please include as much information as you can. Details like these are incredibly 45 | useful in helping the us evaluate and prioritize any changes: 46 | 47 | - A reproducible test case or series of steps. 48 | - Any modifications you've made relevant to the bug. 49 | - Anything unusual about your environment or deployment. 50 | 51 | You can also start a discussion on the GitHub [discussions][gh-discussions] area to ask questions or 52 | share ideas. 53 | 54 | ## License 55 | 56 | © Broadcom. All Rights Reserved. 57 | 58 | The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. 59 | 60 | This project is licensed under the [BSD 2-Clause License](LICENSE). 61 | 62 | [changelog]: CHANGELOG.md 63 | [contributing]: CONTRIBUTING.md 64 | [docs-module]: https://vmware.github.io/powershell-module-for-vmware-cloud-foundation-password-management 65 | [gh-discussions]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/discussions 66 | [gh-issues]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/issues 67 | [gh-reactions]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/ 68 | [psgallery-module]: https://www.powershellgallery.com/packages/VMware.CloudFoundation.PasswordManagement 69 | -------------------------------------------------------------------------------- /docs/assets/images/icon-color.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/assets/images/icon-white.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 8 | 11 | 14 | 19 | 23 | 24 | -------------------------------------------------------------------------------- /docs/assets/stylesheets/extra.css: -------------------------------------------------------------------------------- 1 | .green { 2 | color: green; 3 | } 4 | .red { 5 | color: red; 6 | } 7 | -------------------------------------------------------------------------------- /docs/community/code-of-conduct.md: -------------------------------------------------------------------------------- 1 | --8<-- "./CODE_OF_CONDUCT.md" 2 | -------------------------------------------------------------------------------- /docs/community/contributing.md: -------------------------------------------------------------------------------- 1 | --8<-- "./CONTRIBUTING.md" 2 | -------------------------------------------------------------------------------- /docs/community/index.md: -------------------------------------------------------------------------------- 1 | # Community 2 | 3 | This PowerShell module is the work of many contributors and the project team appreciates your help! 4 | 5 | Thank you for your interest in the project. Whether it's a bug report, enhancement, correction, or 6 | additional documentation, we greatly value feedback and contributions from our community. 7 | -------------------------------------------------------------------------------- /docs/community/support.md: -------------------------------------------------------------------------------- 1 | # Support 2 | 3 | :octicons-heart-24:   This module is community-driven and maintained by the project 4 | contributors. It is not officially supported by Broadcom Support but thrives on collaboration and 5 | input from its users. 6 | 7 | :octicons-issue-opened-24:   Use the GitHub [issues][issues] to report bugs or suggest 8 | enhancements. 9 | 10 | :octicons-thumbsup-24:   Issues are monitored by the maintainers and are prioritized based on 11 | criticality and community [reactions][reactions]. 12 | 13 | :octicons-search-24:   Before opening an issue, please [search the issues][issues-search] and 14 | use the reactions to add votes to matching issues. Please include as much information as you can. 15 | Details like these are incredibly useful in helping the us evaluate and prioritize any changes: 16 | 17 | - A reproducible test case or series of steps. 18 | - Any modifications you've made relevant to the bug. 19 | - Anything unusual about your environment or deployment. 20 | 21 | :octicons-comment-discussion-24:   You can also start a discussion on the GitHub [discussions][discussions] 22 | area to ask questions or share ideas. 23 | 24 | [issues]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/issues 25 | [issues-search]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/issues?q=is%3Aissue+is%3Aopen+label%3Abug 26 | [discussions]: https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/discussions 27 | [reactions]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/ 28 | -------------------------------------------------------------------------------- /docs/documentation/functions/Get-PasswordPolicyDefault.md: -------------------------------------------------------------------------------- 1 | # Get-PasswordPolicyDefault 2 | 3 | ## Synopsis 4 | 5 | Get password policy default settings. 6 | 7 | ## Syntax 8 | 9 | ### All (Default) 10 | 11 | ```powershell 12 | Get-PasswordPolicyDefault -version [] 13 | ``` 14 | 15 | ### json 16 | 17 | ```powershell 18 | Get-PasswordPolicyDefault [-generateJson] -version [-jsonFile ] [-force ] [] 19 | ``` 20 | 21 | ## Description 22 | 23 | The `Get-PasswordPolicyDefault` cmdlet returns the default password policy settings, it can also be used to generate the base JSON file used with Password Policy Manager. 24 | 25 | Default settings for VMware products include: 26 | 27 | - VMware SDDC Manager 28 | - VMware ESX 29 | - VMware vCenter Single Sign-On 30 | - VMware vCenter 31 | - VMware NSX Manager 32 | - VMware NSX Edge 33 | - VMware Workspace ONE Access 34 | 35 | ## Examples 36 | 37 | ### Example 1 38 | 39 | ```powershell 40 | Get-PasswordPolicyDefault -version '5.0.0.0' 41 | ``` 42 | 43 | This example returns the default password policy settings for the VMware Cloud Foundation version. 44 | 45 | ### Example 2 46 | 47 | ```powershell 48 | Get-PasswordPolicyDefault -generateJson -jsonFile [policy_file].json -version '5.0.0.0' 49 | ``` 50 | 51 | This example creates a JSON file with the default password policy settings for the given version of VMware Cloud Foundation. 52 | 53 | ### Example 3 54 | 55 | ```powershell 56 | Get-PasswordPolicyDefault -generateJson -jsonFile [policy_file].json -version '5.0.0.0' -force 57 | ``` 58 | 59 | This example creates a JSON file with the default password policy settings for the given version of VMware Cloud Foundation. 60 | 61 | If the policy configuration file is already present, it is overwritten due to `force` parameter. 62 | 63 | ## Parameters 64 | 65 | ### -generateJson 66 | 67 | Switch to generate a JSON file. 68 | 69 | ```yaml 70 | Type: SwitchParameter 71 | Parameter Sets: json 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 | ### -version 82 | 83 | The VMware Cloud Foundation version to get policy defaults for the JSON file. 84 | 85 | ```yaml 86 | Type: String 87 | Parameter Sets: (All) 88 | Aliases: 89 | 90 | Required: True 91 | Position: Named 92 | Default value: 5.0.0 93 | Accept pipeline input: False 94 | Accept wildcard characters: False 95 | ``` 96 | 97 | ### -jsonFile 98 | 99 | The name of the JSON file to generate. 100 | 101 | ```yaml 102 | Type: String 103 | Parameter Sets: json 104 | Aliases: 105 | 106 | Required: True 107 | Position: Named 108 | Default value: None 109 | Accept pipeline input: False 110 | Accept wildcard characters: False 111 | ``` 112 | 113 | ### -force 114 | 115 | The switch used to overwrite the JSON file if already exists. 116 | 117 | ```yaml 118 | Type: Switch 119 | Parameter Sets: json 120 | Aliases: 121 | 122 | Required: False 123 | Position: Named 124 | Default value: None 125 | Accept pipeline input: False 126 | Accept wildcard characters: False 127 | ``` 128 | 129 | ### Common Parameters 130 | 131 | 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). 132 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtEdgeAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtEdgeAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Retrieves the account lockout policy for NSX Edge nodes. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtEdgeAccountLockout -server -user -pass -domain [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtEdgeAccountLockout` cmdlet retrieves the account lockout policy for NSX Edge nodes within a workload domain. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to NSX Local Manager 20 | - Retrieves the account lockout policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-NsxtEdgeAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example retrieving the account lockout policy for NSX Edge nodes in the workload domain. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-NsxtEdgeAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json 36 | ``` 37 | 38 | This example retrieving the account lockout policy for NSX Edge nodes in the workload domain and checks the configuration drift using the provided configuration JSON. 39 | 40 | ### Example 3 41 | 42 | ```powershell 43 | Request-NsxtEdgeAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift 44 | ``` 45 | 46 | This example retrieving the account lockout policy for NSX Edge nodes in the workload domain and compares the configuration against the product defaults. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -domain 99 | 100 | The name of the workload domain to retrieve the policy from. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -drift 115 | 116 | Switch to compare the current configuration against the product defaults or a JSON file. 117 | 118 | ```yaml 119 | Type: SwitchParameter 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: Named 125 | Default value: False 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -reportPath 131 | 132 | The path to save the policy report. 133 | 134 | ```yaml 135 | Type: String 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: Named 141 | Default value: None 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -policyFile 147 | 148 | The path to the policy configuration file. 149 | 150 | ```yaml 151 | Type: String 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: Named 157 | Default value: None 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtEdgePasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtEdgePasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Retrieves the password expiration policy for NSX Edge nodes. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtEdgePasswordExpiration -server -user -pass -domain [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtEdgePasswordExpiration` cmdlet retrieves the password complexity policy for all NSX Edge node users for a workload domain. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to NSX Local Manager 20 | - Retrieves the password expiration policy for all users 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-NsxtEdgePasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example retrieves the password expiration policy for all users for the NSX Edge nodes for a workload domain. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-NsxtEdgePasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json 36 | ``` 37 | 38 | This example retrieves the password expiration policy for all users for the NSX Edge nodes for a workload domain and checks the configuration drift using the provided configuration JSON. 39 | 40 | ### Example 3 41 | 42 | ```powershell 43 | Request-NsxtEdgePasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift 44 | ``` 45 | 46 | This example retrieves the password expiration policy for all users for the NSX Edge nodes for a workload domain and compares the configuration against the product defaults. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -domain 99 | 100 | The name of the workload domain to retrieve the policy from. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -drift 115 | 116 | Switch to compare the current configuration against the product defaults or a JSON file. 117 | 118 | ```yaml 119 | Type: SwitchParameter 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: Named 125 | Default value: False 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -reportPath 131 | 132 | The path to save the policy report. 133 | 134 | ```yaml 135 | Type: String 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: Named 141 | Default value: None 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -policyFile 147 | 148 | The path to the policy configuration file. 149 | 150 | ```yaml 151 | Type: String 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: Named 157 | Default value: None 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtManagerAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtManagerAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Retrieves the account lockout policy for NSX Local Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtManagerAccountLockout -server -user -pass -domain [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtManagerAccountLockout` cmdlet retrieves the account lockout policy for each NSX Local Manager node for a workload domain. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to NSX Local Manager 20 | - Retrieves the account lockpout policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-NsxtManagerAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example retrieves the account lockout policy for the NSX Local Manager nodes in the workload domain. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-NsxtManagerAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json 36 | ``` 37 | 38 | This example retrieves the account lockout policy for the NSX Local Manager nodes in the workload domain and checks the configuration drift using the provided configuration JSON. 39 | 40 | ### Example 3 41 | 42 | ```powershell 43 | Request-NsxtManagerAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift 44 | ``` 45 | 46 | This example retrieves the account lockout policy for the NSX Local Manager nodes in the workload domain and compares the configuration against the product defaults. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -domain 99 | 100 | The name of the workload domain to retrieve the policy from. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -drift 115 | 116 | Switch to compare the current configuration against the product defaults or a JSON file. 117 | 118 | ```yaml 119 | Type: SwitchParameter 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: Named 125 | Default value: False 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -reportPath 131 | 132 | The path to save the policy report. 133 | 134 | ```yaml 135 | Type: String 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: Named 141 | Default value: None 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -policyFile 147 | 148 | The path to the policy configuration file. 149 | 150 | ```yaml 151 | Type: String 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: Named 157 | Default value: None 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtManagerPasswordComplexity.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtManagerPasswordComplexity 2 | 3 | ## Synopsis 4 | 5 | Retrieves the password complexity policy for NSX Local Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtManagerPasswordComplexity -server -user -pass -domain [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtManagerPasswordComplexity` cmdlet retrieves the password complexity policy for each NSX Local Manager node for a workload domain. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to NSX Local Manager 20 | - Retrieves the password complexity policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-NsxtManagerPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example retrieves the password complexity policy for each NSX Local Manager node for a workload domain. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-NsxtManagerPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json 36 | ``` 37 | 38 | This example retrieves the password complexity policy for each NSX Local Manager node for a workload domain and checks the configuration drift using the provided configuration JSON. 39 | 40 | ### Example 3 41 | 42 | ```powershell 43 | Request-NsxtManagerPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift 44 | ``` 45 | 46 | This example retrieves the password complexity policy for each NSX Local Manager node for a workload domain and compares the configuration against the product defaults. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -domain 99 | 100 | The name of the workload domain to retrieve the policy from. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -drift 115 | 116 | Switch to compare the current configuration against the product defaults or a JSON file. 117 | 118 | ```yaml 119 | Type: SwitchParameter 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: Named 125 | Default value: False 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -reportPath 131 | 132 | The path to save the policy report. 133 | 134 | ```yaml 135 | Type: String 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: Named 141 | Default value: None 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -policyFile 147 | 148 | The path to the policy configuration file. 149 | 150 | ```yaml 151 | Type: String 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: Named 157 | Default value: None 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-NsxtManagerPasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Request-NsxtManagerPasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Retrieves the password expiration policy for NSX Local Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-NsxtManagerPasswordExpiration -server -user -pass -domain [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-NsxtManagerPasswordExpiration` cmdlet retrieves the password complexity policy for all NSX Local Manager cluster users for a workload domain. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to NSX Local Manager 20 | - Retrieves the password expiration policy for all users 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-NsxtManagerPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example retrieves the password expiration policy for all users for the NSX Local Manager cluster for a workload domain. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-NsxtManagerPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json 36 | ``` 37 | 38 | This example retrieves the password expiration policy for all users for the NSX Local Manager cluster for a workload domain and checks the configuration drift using the provided configuration JSON. 39 | 40 | ### Example 3 41 | 42 | ```powershell 43 | Request-NsxtManagerPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift 44 | ``` 45 | 46 | This example retrieves the password expiration policy for all users for the NSX Local Manager cluster for a workload domain and compares the configuration against the product defaults. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -domain 99 | 100 | The name of the workload domain to retrieve the policy from. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -drift 115 | 116 | Switch to compare the current configuration against the product defaults or a JSON file. 117 | 118 | ```yaml 119 | Type: SwitchParameter 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: Named 125 | Default value: False 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -reportPath 131 | 132 | The path to save the policy report. 133 | 134 | ```yaml 135 | Type: String 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: Named 141 | Default value: None 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -policyFile 147 | 148 | The path to the policy configuration file. 149 | 150 | ```yaml 151 | Type: String 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: Named 157 | Default value: None 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-PasswordRotationPolicy.md: -------------------------------------------------------------------------------- 1 | # Request-PasswordRotationPolicy 2 | 3 | ## Synopsis 4 | 5 | Retrieves the credential password rotation settings for credentials managed by SDDC Manager based on the resource type 6 | for a specified workload domain. 7 | 8 | ## Syntax 9 | 10 | ```powershell 11 | Request-PasswordRotationPolicy [-server] [-user] [-pass] [[-domain] ] [[-resource] ] [] 12 | ``` 13 | 14 | ## Description 15 | 16 | The `Request-PasswordRotationPolicy` cmdlet retrieves the credential password rotation settings for credentials managed by SDDC Manager. 17 | 18 | The cmdlet connects to the SDDC Manager using the `-server`, `-user`, and `-pass` values: 19 | 20 | - Validates that network connectivity and authentication is possible to SDDC Manager. 21 | - Retrieves the credential password rotation settings based on the criteria specified by the -domain and -resource values or all resource types for all workload domains if no values are specified 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-PasswordRotationPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] 29 | ``` 30 | 31 | This example retrieves the credential password rotation settings for all resource types managed by SDDC Manager for all workload domains. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-PasswordRotationPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 37 | ``` 38 | 39 | This example retrieves the credential password rotation settings for all resource types managed by SDDC Manager for the workload domain. 40 | 41 | ### Example 3 42 | 43 | ```powershell 44 | Request-PasswordRotationPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -resource nsxManager 45 | ``` 46 | 47 | This example retrieves the credential password rotation settings for the NSX Manager accounts managed by SDDC Manager for all workload domains. 48 | 49 | ### Example 4 50 | 51 | ```powershell 52 | Request-PasswordRotationPolicy -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -resource nsxManager 53 | ``` 54 | 55 | This example retrieves the credential password rotation settings for the NSX Manager accounts managed by SDDC Manager for the workload domain. 56 | 57 | ## Parameters 58 | 59 | ### -server 60 | 61 | The fully qualified domain name of the SDDC Manager instance. 62 | 63 | ```yaml 64 | Type: String 65 | Parameter Sets: (All) 66 | Aliases: 67 | 68 | Required: True 69 | Position: 1 70 | Default value: None 71 | Accept pipeline input: False 72 | Accept wildcard characters: False 73 | ``` 74 | 75 | ### -user 76 | 77 | The username to authenticate to the SDDC Manager instance. 78 | 79 | ```yaml 80 | Type: String 81 | Parameter Sets: (All) 82 | Aliases: 83 | 84 | Required: True 85 | Position: 2 86 | Default value: None 87 | Accept pipeline input: False 88 | Accept wildcard characters: False 89 | ``` 90 | 91 | ### -pass 92 | 93 | The password to authenticate to the SDDC Manager instance. 94 | 95 | ```yaml 96 | Type: String 97 | Parameter Sets: (All) 98 | Aliases: 99 | 100 | Required: True 101 | Position: 3 102 | Default value: None 103 | Accept pipeline input: False 104 | Accept wildcard characters: False 105 | ``` 106 | 107 | ### -domain 108 | 109 | The name of the workload domain to retrieve the user password rotation settings for. 110 | 111 | ```yaml 112 | Type: String 113 | Parameter Sets: (All) 114 | Aliases: 115 | 116 | Required: False 117 | Position: 4 118 | Default value: None 119 | Accept pipeline input: False 120 | Accept wildcard characters: False 121 | ``` 122 | 123 | ### -resource 124 | 125 | The resource type to retrieve the user password rotation settings for. One of: `sso`, `vcenterServer`, `nsxManager`, `nsxEdge`, `ariaLifecycle`, `ariaOperations`, `ariaOperationsLogs`, `ariaAutomation`, `workspaceOneAccess`, `backup`. 126 | 127 | ```yaml 128 | Type: String 129 | Parameter Sets: (All) 130 | Aliases: 131 | 132 | Required: False 133 | Position: 5 134 | Default value: None 135 | Accept pipeline input: False 136 | Accept wildcard characters: False 137 | ``` 138 | 139 | ### Common Parameters 140 | 141 | 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). 142 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-SddcManagerAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Request-SddcManagerAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Retrieves the account lockout policy for an SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-SddcManagerAccountLockout -server -user -pass -rootPass [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-SddcManagerAccountLockout` cmdlet retrieves the account lockout policy for an SDDC Manager. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Retrieves the account lockout policy for an SDDC Manager 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-SddcManagerAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -rootPass [root_password] 28 | ``` 29 | 30 | This example retrieves the account lockout policy for an SDDC Manager. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-SddcManagerAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -rootPass [root_password] -drift -reportPath [report_path] -policyFile [policy_file].json 36 | ``` 37 | 38 | This example retrieves the account lockout policy for an SDDC Manager and and compares the configuration against the policy configuration file. 39 | 40 | ### Example 3 41 | 42 | ```powershell 43 | Request-SddcManagerAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -rootPass [root_password] -drift 44 | ``` 45 | 46 | This example retrieves the account lockout policy for an SDDC Manager and compares the configuration against the product defaults. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -rootPass 99 | 100 | The password for the SDDC Manager appliance root account. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -drift 115 | 116 | Switch to compare the current configuration against the product defaults or a JSON file. 117 | 118 | ```yaml 119 | Type: SwitchParameter 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: Named 125 | Default value: False 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -reportPath 131 | 132 | The path to save the policy report. 133 | 134 | ```yaml 135 | Type: String 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: Named 141 | Default value: None 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -policyFile 147 | 148 | The path to the password policy file to compare against. 149 | 150 | ```yaml 151 | Type: String 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: Named 157 | Default value: None 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-SddcManagerPasswordComplexity.md: -------------------------------------------------------------------------------- 1 | # Request-SddcManagerPasswordComplexity 2 | 3 | ## Synopsis 4 | 5 | Retrieves the password complexity policy for an SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-SddcManagerPasswordComplexity -server -user -pass -rootPass [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-SddcManagerPasswordComplexity` cmdlet retrieves the password complexity policy for an SDDC Manager. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Retrieves the password complexity policy 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Request-SddcManagerPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -rootPass [root_password] 27 | ``` 28 | 29 | This example retrieves the password complexity policy for an SDDC Manager. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Request-SddcManagerPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -rootPass [root_password] -drift -reportPath [report_path] -policyFile [policy_file].json 35 | ``` 36 | 37 | This example retrieves the password complexity policy for an SDDC Manager and compares the configuration against the policy configuration file. 38 | 39 | ### Example 3 40 | 41 | ```powershell 42 | Request-SddcManagerPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -rootPass [root_password] -drift 43 | ``` 44 | 45 | This example retrieves the password complexity policy for an SDDC Manager and compares the configuration against the product defaults. 46 | 47 | ## Parameters 48 | 49 | ### -server 50 | 51 | The fully qualified domain name of the SDDC Manager instance. 52 | 53 | ```yaml 54 | Type: String 55 | Parameter Sets: (All) 56 | Aliases: 57 | 58 | Required: True 59 | Position: Named 60 | Default value: None 61 | Accept pipeline input: False 62 | Accept wildcard characters: False 63 | ``` 64 | 65 | ### -user 66 | 67 | The username to authenticate to the SDDC Manager instance. 68 | 69 | ```yaml 70 | Type: String 71 | Parameter Sets: (All) 72 | Aliases: 73 | 74 | Required: True 75 | Position: Named 76 | Default value: None 77 | Accept pipeline input: False 78 | Accept wildcard characters: False 79 | ``` 80 | 81 | ### -pass 82 | 83 | The password to authenticate to the SDDC Manager instance. 84 | 85 | ```yaml 86 | Type: String 87 | Parameter Sets: (All) 88 | Aliases: 89 | 90 | Required: True 91 | Position: Named 92 | Default value: None 93 | Accept pipeline input: False 94 | Accept wildcard characters: False 95 | ``` 96 | 97 | ### -rootPass 98 | 99 | The password for the SDDC Manager appliance root account. 100 | 101 | ```yaml 102 | Type: String 103 | Parameter Sets: (All) 104 | Aliases: 105 | 106 | Required: True 107 | Position: Named 108 | Default value: None 109 | Accept pipeline input: False 110 | Accept wildcard characters: False 111 | ``` 112 | 113 | ### -drift 114 | 115 | Switch to compare the current configuration against the product defaults or a JSON file. 116 | 117 | ```yaml 118 | Type: SwitchParameter 119 | Parameter Sets: (All) 120 | Aliases: 121 | 122 | Required: False 123 | Position: Named 124 | Default value: False 125 | Accept pipeline input: False 126 | Accept wildcard characters: False 127 | ``` 128 | 129 | ### -reportPath 130 | 131 | The path to save the policy report. 132 | 133 | ```yaml 134 | Type: String 135 | Parameter Sets: (All) 136 | Aliases: 137 | 138 | Required: False 139 | Position: Named 140 | Default value: None 141 | Accept pipeline input: False 142 | Accept wildcard characters: False 143 | ``` 144 | 145 | ### -policyFile 146 | 147 | The path to the password policy file to compare against. 148 | 149 | ```yaml 150 | Type: String 151 | Parameter Sets: (All) 152 | Aliases: 153 | 154 | Required: False 155 | Position: Named 156 | Default value: None 157 | Accept pipeline input: False 158 | Accept wildcard characters: False 159 | ``` 160 | 161 | ### Common Parameters 162 | 163 | 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). 164 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-SddcManagerPasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Request-SddcManagerPasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Retrieves the password expiration policy for an SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-SddcManagerPasswordExpiration -server -user -pass -rootPass [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-SddcManagerPasswordExpiration` cmdlet retrieves the password expiration policy for an SDDC Manager. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Retrieves the password expiration policy 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Request-SddcManagerPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -rootPass [root_password] 27 | ``` 28 | 29 | This example retrieves the password expiration policy for an SDDC Manager. 30 | 31 | ### Example 2 32 | 33 | ```powershell 34 | Request-SddcManagerPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -rootPass [root_password] -drift -reportPath [report_path] -policyFile [policy_file].json 35 | ``` 36 | 37 | This example retrieves the password expiration policy for an SDDC Manager and compares the configuration against the policy configuration file. 38 | 39 | ### Example 3 40 | 41 | ```powershell 42 | Request-SddcManagerPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -rootPass [root_password] -drift 43 | ``` 44 | 45 | This example retrieves the password expiration policy for an SDDC Manager and compares the configuration against the product defaults. 46 | 47 | ## Parameters 48 | 49 | ### -server 50 | 51 | The fully qualified domain name of the SDDC Manager instance. 52 | 53 | ```yaml 54 | Type: String 55 | Parameter Sets: (All) 56 | Aliases: 57 | 58 | Required: True 59 | Position: Named 60 | Default value: None 61 | Accept pipeline input: False 62 | Accept wildcard characters: False 63 | ``` 64 | 65 | ### -user 66 | 67 | The username to authenticate to the SDDC Manager instance. 68 | 69 | ```yaml 70 | Type: String 71 | Parameter Sets: (All) 72 | Aliases: 73 | 74 | Required: True 75 | Position: Named 76 | Default value: None 77 | Accept pipeline input: False 78 | Accept wildcard characters: False 79 | ``` 80 | 81 | ### -pass 82 | 83 | The password to authenticate to the SDDC Manager instance. 84 | 85 | ```yaml 86 | Type: String 87 | Parameter Sets: (All) 88 | Aliases: 89 | 90 | Required: True 91 | Position: Named 92 | Default value: None 93 | Accept pipeline input: False 94 | Accept wildcard characters: False 95 | ``` 96 | 97 | ### -rootPass 98 | 99 | The password for the SDDC Manager appliance root account. 100 | 101 | ```yaml 102 | Type: String 103 | Parameter Sets: (All) 104 | Aliases: 105 | 106 | Required: True 107 | Position: Named 108 | Default value: None 109 | Accept pipeline input: False 110 | Accept wildcard characters: False 111 | ``` 112 | 113 | ### -drift 114 | 115 | Switch to compare the current configuration against the product defaults or a JSON file. 116 | 117 | ```yaml 118 | Type: SwitchParameter 119 | Parameter Sets: (All) 120 | Aliases: 121 | 122 | Required: False 123 | Position: Named 124 | Default value: False 125 | Accept pipeline input: False 126 | Accept wildcard characters: False 127 | ``` 128 | 129 | ### -reportPath 130 | 131 | The path to save the policy report. 132 | 133 | ```yaml 134 | Type: String 135 | Parameter Sets: (All) 136 | Aliases: 137 | 138 | Required: False 139 | Position: Named 140 | Default value: None 141 | Accept pipeline input: False 142 | Accept wildcard characters: False 143 | ``` 144 | 145 | ### -policyFile 146 | 147 | The path to the password policy file to compare against. 148 | 149 | ```yaml 150 | Type: String 151 | Parameter Sets: (All) 152 | Aliases: 153 | 154 | Required: False 155 | Position: Named 156 | Default value: None 157 | Accept pipeline input: False 158 | Accept wildcard characters: False 159 | ``` 160 | 161 | ### Common Parameters 162 | 163 | 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). 164 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-SsoAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Request-SsoAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Retrieves the account lockout policy policy for a vCenter Single Sign-On domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-SsoAccountLockout -server -user -pass -domain [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-SsoAccountLockout` cmdlet retrieves the vCenter Single Sign-On domain account lockout policy. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that the workload domain exists in the SDDC Manager inventory 20 | - Validates that network connectivity and authentication is possible to vCenter Single Sign-On domain 21 | - Retrieves the account lockout policy 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-SsoAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example retrieves the account lockout policy for vCenter Single Sign-On domain of the workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-SsoAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json 37 | ``` 38 | 39 | This example retrieves the account lockout policy for vCenter Single Sign-On domain of the workload domain and compares the configuration against the policy configuration file. 40 | 41 | ### Example 3 42 | 43 | ```powershell 44 | Request-SsoAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift 45 | ``` 46 | 47 | This example retrieves the account lockout policy for vCenter Single Sign-On domain and compares the configuration against the product defaults. 48 | 49 | ## Parameters 50 | 51 | ### -server 52 | 53 | The fully qualified domain name of the SDDC Manager instance. 54 | 55 | ```yaml 56 | Type: String 57 | Parameter Sets: (All) 58 | Aliases: 59 | 60 | Required: True 61 | Position: Named 62 | Default value: None 63 | Accept pipeline input: False 64 | Accept wildcard characters: False 65 | ``` 66 | 67 | ### -user 68 | 69 | The username to authenticate to the SDDC Manager instance. 70 | 71 | ```yaml 72 | Type: String 73 | Parameter Sets: (All) 74 | Aliases: 75 | 76 | Required: True 77 | Position: Named 78 | Default value: None 79 | Accept pipeline input: False 80 | Accept wildcard characters: False 81 | ``` 82 | 83 | ### -pass 84 | 85 | The password to authenticate to the SDDC Manager instance. 86 | 87 | ```yaml 88 | Type: String 89 | Parameter Sets: (All) 90 | Aliases: 91 | 92 | Required: True 93 | Position: Named 94 | Default value: None 95 | Accept pipeline input: False 96 | Accept wildcard characters: False 97 | ``` 98 | 99 | ### -domain 100 | 101 | The name of the workload domain to retrieve the policy from. 102 | 103 | ```yaml 104 | Type: String 105 | Parameter Sets: (All) 106 | Aliases: 107 | 108 | Required: True 109 | Position: Named 110 | Default value: None 111 | Accept pipeline input: False 112 | Accept wildcard characters: False 113 | ``` 114 | 115 | ### -drift 116 | 117 | Switch to compare the current configuration against the product defaults or a JSON file. 118 | 119 | ```yaml 120 | Type: SwitchParameter 121 | Parameter Sets: (All) 122 | Aliases: 123 | 124 | Required: False 125 | Position: Named 126 | Default value: False 127 | Accept pipeline input: False 128 | Accept wildcard characters: False 129 | ``` 130 | 131 | ### -reportPath 132 | 133 | The path to save the policy report. 134 | 135 | ```yaml 136 | Type: String 137 | Parameter Sets: (All) 138 | Aliases: 139 | 140 | Required: False 141 | Position: Named 142 | Default value: None 143 | Accept pipeline input: False 144 | Accept wildcard characters: False 145 | ``` 146 | 147 | ### -policyFile 148 | 149 | The path to the policy configuration file. 150 | 151 | ```yaml 152 | Type: String 153 | Parameter Sets: (All) 154 | Aliases: 155 | 156 | Required: False 157 | Position: Named 158 | Default value: None 159 | Accept pipeline input: False 160 | Accept wildcard characters: False 161 | ``` 162 | 163 | ### Common Parameters 164 | 165 | 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). 166 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-SsoPasswordComplexity.md: -------------------------------------------------------------------------------- 1 | # Request-SsoPasswordComplexity 2 | 3 | ## Synopsis 4 | 5 | Retrieves the password complexity policy for a vCenter Single Sign-On domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-SsoPasswordComplexity -server -user -pass -domain [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-SsoPasswordComplexity` cmdlet retrieves the vCenter Single Sign-On domain password complexity policy. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that the workload domain exists in the SDDC Manager inventory 20 | - Validates that network connectivity and authentication is possible to vCenter Single Sign-On domain 21 | - Retrieves the password complexity policy 22 | 23 | ## Examples 24 | 25 | ### Example 1 26 | 27 | ```powershell 28 | Request-SsoPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 29 | ``` 30 | 31 | This example retrieves the password complexity policy for vCenter Single Sign-On domain of the workload domain. 32 | 33 | ### Example 2 34 | 35 | ```powershell 36 | Request-SsoPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json 37 | ``` 38 | 39 | This example retrieves the password complexity policy for vCenter Single Sign-On domain of the workload domain and compares the configuration against the policy configuration file. 40 | 41 | ### Example 3 42 | 43 | ```powershell 44 | Request-SsoPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift 45 | ``` 46 | 47 | This example retrieves the password complexity policy for vCenter Single Sign-On domain of the workload domain and compares the configuration against the product defaults. 48 | 49 | ## Parameters 50 | 51 | ### -server 52 | 53 | The fully qualified domain name of the SDDC Manager instance. 54 | 55 | ```yaml 56 | Type: String 57 | Parameter Sets: (All) 58 | Aliases: 59 | 60 | Required: True 61 | Position: Named 62 | Default value: None 63 | Accept pipeline input: False 64 | Accept wildcard characters: False 65 | ``` 66 | 67 | ### -user 68 | 69 | The username to authenticate to the SDDC Manager instance. 70 | 71 | ```yaml 72 | Type: String 73 | Parameter Sets: (All) 74 | Aliases: 75 | 76 | Required: True 77 | Position: Named 78 | Default value: None 79 | Accept pipeline input: False 80 | Accept wildcard characters: False 81 | ``` 82 | 83 | ### -pass 84 | 85 | The password to authenticate to the SDDC Manager instance. 86 | 87 | ```yaml 88 | Type: String 89 | Parameter Sets: (All) 90 | Aliases: 91 | 92 | Required: True 93 | Position: Named 94 | Default value: None 95 | Accept pipeline input: False 96 | Accept wildcard characters: False 97 | ``` 98 | 99 | ### -domain 100 | 101 | The name of the workload domain to retrieve the policy from. 102 | 103 | ```yaml 104 | Type: String 105 | Parameter Sets: (All) 106 | Aliases: 107 | 108 | Required: True 109 | Position: Named 110 | Default value: None 111 | Accept pipeline input: False 112 | Accept wildcard characters: False 113 | ``` 114 | 115 | ### -drift 116 | 117 | Switch to compare the current configuration against the product defaults or a JSON file. 118 | 119 | ```yaml 120 | Type: SwitchParameter 121 | Parameter Sets: (All) 122 | Aliases: 123 | 124 | Required: False 125 | Position: Named 126 | Default value: False 127 | Accept pipeline input: False 128 | Accept wildcard characters: False 129 | ``` 130 | 131 | ### -reportPath 132 | 133 | The path to save the policy report. 134 | 135 | ```yaml 136 | Type: String 137 | Parameter Sets: (All) 138 | Aliases: 139 | 140 | Required: False 141 | Position: Named 142 | Default value: None 143 | Accept pipeline input: False 144 | Accept wildcard characters: False 145 | ``` 146 | 147 | ### -policyFile 148 | 149 | The path to the policy configuration file. 150 | 151 | ```yaml 152 | Type: String 153 | Parameter Sets: (All) 154 | Aliases: 155 | 156 | Required: False 157 | Position: Named 158 | Default value: None 159 | Accept pipeline input: False 160 | Accept wildcard characters: False 161 | ``` 162 | 163 | ### Common Parameters 164 | 165 | 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). 166 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-SsoPasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Request-SsoPasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Retrieves the password expiration policy for a vCenter Single Sign-On domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-SsoPasswordExpiration -server -user -pass -domain [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-SsoPasswordExpiration` cmdlet retrieves the password expiration policy for a vCenter Single Sign-On domain. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Retrieves the global password expiration policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-SsoPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example retrieves the password expiration policy for the vCenter Single Sign-On domain. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-SsoPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json 36 | ``` 37 | 38 | This example retrieves the password expiration policy for the vCenter Single Sign-On domain and compares the configuration against the policy configuration file. 39 | 40 | ### Example 3 41 | 42 | ```powershell 43 | Request-SsoPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift 44 | ``` 45 | 46 | This example retrieves the password expiration policy for the vCenter Single Sign-On domain and compares the configuration against the product defaults. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -domain 99 | 100 | The name of the workload domain to retrieve the policy from. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -drift 115 | 116 | Switch to compare the current configuration against the product defaults or a JSON file. 117 | 118 | ```yaml 119 | Type: SwitchParameter 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: Named 125 | Default value: False 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -reportPath 131 | 132 | The path to save the policy report. 133 | 134 | ```yaml 135 | Type: String 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: Named 141 | Default value: None 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -policyFile 147 | 148 | The path to the policy configuration file. 149 | 150 | ```yaml 151 | Type: String 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: Named 157 | Default value: None 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VcenterAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Request-VcenterAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Retrieves the account lockout policy for a vCenter instance based on the workload domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VcenterAccountLockout -server -user -pass -domain [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VcenterAccountLockout` cmdlet retrieves the account lockout policy of a vCenter instance. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Retrieves the account lockout policy for a vCenter instance based on the workload domain 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-VcenterAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example retrieves the account lockout policy for a vCenter instance based on the workload domain. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-VcenterAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json 36 | ``` 37 | 38 | This example retrieves the account lockout policy for a vCenter instance based on the workload domain and checks the configuration drift using the provided configuration JSON. 39 | 40 | ### Example 3 41 | 42 | ```powershell 43 | Request-VcenterAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift 44 | ``` 45 | 46 | This example retrieves the account lockout policy for a vCenter instance based on the workload domain and compares the configuration against the product defaults. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -domain 99 | 100 | The name of the workload domain to retrieve the policy from. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -drift 115 | 116 | Switch to compare the current configuration against the product defaults or a JSON file. 117 | 118 | ```yaml 119 | Type: SwitchParameter 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: Named 125 | Default value: False 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -reportPath 131 | 132 | The path to save the policy report. 133 | 134 | ```yaml 135 | Type: String 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: Named 141 | Default value: None 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -policyFile 147 | 148 | The path to the policy configuration file. 149 | 150 | ```yaml 151 | Type: String 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: Named 157 | Default value: None 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VcenterPasswordComplexity.md: -------------------------------------------------------------------------------- 1 | # Request-VcenterPasswordComplexity 2 | 3 | ## Synopsis 4 | 5 | Retrieves the password complexity policy for a vCenter instance based on the workload domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VcenterPasswordComplexity -server -user -pass -domain [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VcenterPasswordComplexity` cmdlet retrieves the password complexity policy of a vCenter instance. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Retrieves the password complexity policy for a vCenter instance based on the workload domain 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-VcenterPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example retrieves the password complexity policy for a vCenter instance based on the workload domain. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-VcenterPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json 36 | ``` 37 | 38 | This example retrieves the password complexity policy for a vCenter instance based on the workload domain and checks the configuration drift using the provided configuration JSON. 39 | 40 | ### Example 3 41 | 42 | ```powershell 43 | Request-VcenterPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift 44 | ``` 45 | 46 | This example retrieves the password complexity policy for a vCenter instance based on the workload domain and compares the configuration against the product defaults. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -domain 99 | 100 | The name of the workload domain to retrieve the policy from. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -drift 115 | 116 | Switch to compare the current configuration against the product defaults or a JSON file. 117 | 118 | ```yaml 119 | Type: SwitchParameter 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: Named 125 | Default value: False 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -reportPath 131 | 132 | The path to save the policy report. 133 | 134 | ```yaml 135 | Type: String 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: Named 141 | Default value: None 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -policyFile 147 | 148 | The path to the policy configuration file. 149 | 150 | ```yaml 151 | Type: String 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: Named 157 | Default value: None 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VcenterPasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Request-VcenterPasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Retrieves the global password expiration policy for a vCenter instance based on the workload domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VcenterPasswordExpiration -server -user -pass -domain [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VcenterPasswordExpiration` cmdlet retrieves the global password expiration policy for a vCenter instance. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Retrieves the global password expiration policy for a vCenter instance based on the workload domain 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-VcenterPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example retrieves the global password expiration policy for a vCenter instance. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-VcenterPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json 36 | ``` 37 | 38 | This example retrieves the global password expiration policy for a vCenter instance and checks the configuration drift using the provided configuration JSON. 39 | 40 | ### Example 3 41 | 42 | ```powershell 43 | Request-VcenterPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift 44 | ``` 45 | 46 | This example retrieves the global password expiration policy for a vCenter instance and compares the configuration against the product defaults. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -domain 99 | 100 | The name of the workload domain to retrieve the policy from. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -drift 115 | 116 | Switch to compare the current configuration against the product defaults or a JSON file. 117 | 118 | ```yaml 119 | Type: SwitchParameter 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: Named 125 | Default value: False 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -reportPath 131 | 132 | The path to save the policy report. 133 | 134 | ```yaml 135 | Type: String 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: Named 141 | Default value: None 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -policyFile 147 | 148 | The path to the policy configuration file. 149 | 150 | ```yaml 151 | Type: String 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: Named 157 | Default value: None 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-VcenterRootPasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Request-VcenterRootPasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Retrieves the `root` user password expiration policy for a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-VcenterRootPasswordExpiration -server -user -pass -domain [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-VcenterRootPasswordExpiration` cmdlet retrieves the `root` user password expiration policy for a vCenter instance. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Retrieves the `root` user password expiration policy for a vCenter instance 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Request-VcenterRootPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] 28 | ``` 29 | 30 | This example retrieves the `root` user password expiration policy for a vCenter instance. 31 | 32 | ### Example 2 33 | 34 | ```powershell 35 | Request-VcenterRootPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift -reportPath [report_path] -policyFile [policy_file].json 36 | ``` 37 | 38 | This example retrieves the `root` user password expiration policy for a vCenter instance and checks the configuration drift using the provided configuration JSON. 39 | 40 | ### Example 3 41 | 42 | ```powershell 43 | Request-VcenterRootPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -drift 44 | ``` 45 | 46 | This example retrieves the `root` user password expiration policy for a vCenter instance and compares the configuration against the product defaults. 47 | 48 | ## Parameters 49 | 50 | ### -server 51 | 52 | The fully qualified domain name of the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -user 67 | 68 | The username to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: Named 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -pass 83 | 84 | The password to authenticate to the SDDC Manager instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: Named 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -domain 99 | 100 | The name of the workload domain to retrieve the policy from. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: Named 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -drift 115 | 116 | Switch to compare the current configuration against the product defaults or a JSON file. 117 | 118 | ```yaml 119 | Type: SwitchParameter 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: Named 125 | Default value: False 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -reportPath 131 | 132 | The path to save the policy report. 133 | 134 | ```yaml 135 | Type: String 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: Named 141 | Default value: None 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -policyFile 147 | 148 | The path to the policy configuration file. 149 | 150 | ```yaml 151 | Type: String 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: Named 157 | Default value: None 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-WsaAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Request-WsaAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Retrieves the account lockout policy for Workspace ONE Access instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-WsaAccountLockout -server -user -pass [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-WsaAccountLockout` cmdlet retrieves the Workspace ONE Access account lockout policy. 16 | 17 | - Validates that network connectivity and authentication is possible to Workspace ONE Access 18 | - Retrieves the account lockout policy for Workspace ONE Access instance 19 | 20 | ## Examples 21 | 22 | ### Example 1 23 | 24 | ```powershell 25 | Request-WsaAccountLockout -server [wsa_fqdn] -user [admin_username] -pass [admin_password] 26 | ``` 27 | 28 | This example retrieves the account lockout policy for Workspace ONE Access instance. 29 | 30 | ### Example 2 31 | 32 | ```powershell 33 | Request-WsaAccountLockout -server [wsa_fqdn] -user [admin_username] -pass [admin_password] -drift -reportPath [report_path] -policyFile [policy_file].json 34 | ``` 35 | 36 | This example retrieves the local user password complexity policy for Workspace ONE Access and checks the configuration drift using the provided configuration JSON. 37 | 38 | ### Example 3 39 | 40 | ```powershell 41 | Request-WsaAccountLockout -server [wsa_fqdn] -user [admin_username] -pass [admin_password] -drift 42 | ``` 43 | 44 | This example retrieves the local user password complexity policy for Workspace ONE Access and compares the configuration against the product defaults. 45 | 46 | ## Parameters 47 | 48 | ### -server 49 | 50 | The fully qualified domain name of the Workspace ONE Access instance. 51 | 52 | ```yaml 53 | Type: String 54 | Parameter Sets: (All) 55 | Aliases: 56 | 57 | Required: True 58 | Position: Named 59 | Default value: None 60 | Accept pipeline input: False 61 | Accept wildcard characters: False 62 | ``` 63 | 64 | ### -user 65 | 66 | The username to authenticate to the Workspace ONE Access instance. 67 | 68 | ```yaml 69 | Type: String 70 | Parameter Sets: (All) 71 | Aliases: 72 | 73 | Required: True 74 | Position: Named 75 | Default value: None 76 | Accept pipeline input: False 77 | Accept wildcard characters: False 78 | ``` 79 | 80 | ### -pass 81 | 82 | The password to authenticate to the Workspace ONE Access instance. 83 | 84 | ```yaml 85 | Type: String 86 | Parameter Sets: (All) 87 | Aliases: 88 | 89 | Required: True 90 | Position: Named 91 | Default value: None 92 | Accept pipeline input: False 93 | Accept wildcard characters: False 94 | ``` 95 | 96 | ### -drift 97 | 98 | Switch to compare the current configuration against the product defaults or a JSON file. 99 | 100 | ```yaml 101 | Type: SwitchParameter 102 | Parameter Sets: (All) 103 | Aliases: 104 | 105 | Required: False 106 | Position: Named 107 | Default value: False 108 | Accept pipeline input: False 109 | Accept wildcard characters: False 110 | ``` 111 | 112 | ### -reportPath 113 | 114 | The path to save the policy report. 115 | 116 | ```yaml 117 | Type: String 118 | Parameter Sets: (All) 119 | Aliases: 120 | 121 | Required: False 122 | Position: Named 123 | Default value: None 124 | Accept pipeline input: False 125 | Accept wildcard characters: False 126 | ``` 127 | 128 | ### -policyFile 129 | 130 | The path to the policy configuration file. 131 | 132 | ```yaml 133 | Type: String 134 | Parameter Sets: (All) 135 | Aliases: 136 | 137 | Required: False 138 | Position: Named 139 | Default value: None 140 | Accept pipeline input: False 141 | Accept wildcard characters: False 142 | ``` 143 | 144 | ### Common Parameters 145 | 146 | 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). 147 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-WsaPasswordComplexity.md: -------------------------------------------------------------------------------- 1 | # Request-WsaPasswordComplexity 2 | 3 | ## Synopsis 4 | 5 | Retrieves the password complexity policy for Workspace ONE Access instance for Workspace ONE Access instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-WsaPasswordComplexity -server -user -pass [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-WsaPasswordComplexity` cmdlet retrieves the Workspace ONE Access password complexity policy. 16 | 17 | - Validates that network connectivity and authentication is possible to Workspace ONE Access 18 | - Retrieves the password complexity policy 19 | 20 | ## Examples 21 | 22 | ### Example 1 23 | 24 | ```powershell 25 | Request-WsaPasswordComplexity -server [wsa_fqdn] -user [admin_username] -pass [admin_password] 26 | ``` 27 | 28 | This example retrieves the password complexity policy for Workspace ONE Access instance. 29 | 30 | ### Example 2 31 | 32 | ```powershell 33 | Request-WsaPasswordComplexity -server [wsa_fqdn] -user [admin_username] -pass [admin_password] -drift -reportPath [report_path] -policyFile [policy_file].json 34 | ``` 35 | 36 | This example retrieves the password complexity policy for Workspace ONE Access instance and checks the configuration drift using the provided configuration JSON. 37 | 38 | ### Example 3 39 | 40 | ```powershell 41 | Request-WsaPasswordComplexity -server [wsa_fqdn] -user [admin_username] -pass [admin_password] -drift 42 | ``` 43 | 44 | This example retrieves the password complexity policy for Workspace ONE Access instance and compares the configuration against the product defaults. 45 | 46 | ## Parameters 47 | 48 | ### -server 49 | 50 | The fully qualified domain name of the Workspace ONE Access instance. 51 | 52 | ```yaml 53 | Type: String 54 | Parameter Sets: (All) 55 | Aliases: 56 | 57 | Required: True 58 | Position: Named 59 | Default value: None 60 | Accept pipeline input: False 61 | Accept wildcard characters: False 62 | ``` 63 | 64 | ### -user 65 | 66 | The username to authenticate to the Workspace ONE Access instance. 67 | 68 | ```yaml 69 | Type: String 70 | Parameter Sets: (All) 71 | Aliases: 72 | 73 | Required: True 74 | Position: Named 75 | Default value: None 76 | Accept pipeline input: False 77 | Accept wildcard characters: False 78 | ``` 79 | 80 | ### -pass 81 | 82 | The password to authenticate to the Workspace ONE Access instance. 83 | 84 | ```yaml 85 | Type: String 86 | Parameter Sets: (All) 87 | Aliases: 88 | 89 | Required: True 90 | Position: Named 91 | Default value: None 92 | Accept pipeline input: False 93 | Accept wildcard characters: False 94 | ``` 95 | 96 | ### -drift 97 | 98 | Switch to compare the current configuration against the product defaults or a JSON file. 99 | 100 | ```yaml 101 | Type: SwitchParameter 102 | Parameter Sets: (All) 103 | Aliases: 104 | 105 | Required: False 106 | Position: Named 107 | Default value: False 108 | Accept pipeline input: False 109 | Accept wildcard characters: False 110 | ``` 111 | 112 | ### -reportPath 113 | 114 | The path to save the policy report. 115 | 116 | ```yaml 117 | Type: String 118 | Parameter Sets: (All) 119 | Aliases: 120 | 121 | Required: False 122 | Position: Named 123 | Default value: None 124 | Accept pipeline input: False 125 | Accept wildcard characters: False 126 | ``` 127 | 128 | ### -policyFile 129 | 130 | The path to the policy configuration file. 131 | 132 | ```yaml 133 | Type: String 134 | Parameter Sets: (All) 135 | Aliases: 136 | 137 | Required: False 138 | Position: Named 139 | Default value: None 140 | Accept pipeline input: False 141 | Accept wildcard characters: False 142 | ``` 143 | 144 | ### Common Parameters 145 | 146 | 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). 147 | -------------------------------------------------------------------------------- /docs/documentation/functions/Request-WsaPasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Request-WsaPasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Retrieves Workspace ONE Access password expiration. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Request-WsaPasswordExpiration -server -user -pass [-drift] [-reportPath ] [-policyFile ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Request-WsaPasswordExpiration` cmdlet retrieves the Workspace ONE Access password expiration policy. 16 | 17 | - Validates that network connectivity and authentication is possible to Workspace ONE Access 18 | - Retrieves the password expiration policy 19 | 20 | ## Examples 21 | 22 | ### Example 1 23 | 24 | ```powershell 25 | Request-WsaPasswordExpiration -server [wsa_fqdn] -user [admin_username] -pass [admin_password] 26 | ``` 27 | 28 | This example retrieves the password expiration policy for the Workspace ONE Access instance. 29 | 30 | ### Example 2 31 | 32 | ```powershell 33 | Request-WsaPasswordExpiration -server [wsa_fqdn] -user [admin_username] -pass [admin_password] -drift -reportPath [report_path] -policyFile [policy_file].json 34 | ``` 35 | 36 | This example retrieves the password expiration policy for the Workspace ONE Access instance= and checks the configuration drift using the provided configuration JSON. 37 | 38 | ### Example 3 39 | 40 | ```powershell 41 | Request-WsaPasswordExpiration -server [wsa_fqdn] -user [admin_username] -pass [admin_password] -drift 42 | ``` 43 | 44 | This example retrieves the password expiration policy for the Workspace ONE Access instance and compares the configuration against the product defaults. 45 | 46 | ## Parameters 47 | 48 | ### -server 49 | 50 | The fully qualified domain name of the Workspace ONE Access instance. 51 | 52 | ```yaml 53 | Type: String 54 | Parameter Sets: (All) 55 | Aliases: 56 | 57 | Required: True 58 | Position: Named 59 | Default value: None 60 | Accept pipeline input: False 61 | Accept wildcard characters: False 62 | ``` 63 | 64 | ### -user 65 | 66 | The username to authenticate to the Workspace ONE Access instance. 67 | 68 | ```yaml 69 | Type: String 70 | Parameter Sets: (All) 71 | Aliases: 72 | 73 | Required: True 74 | Position: Named 75 | Default value: None 76 | Accept pipeline input: False 77 | Accept wildcard characters: False 78 | ``` 79 | 80 | ### -pass 81 | 82 | The password to authenticate to the Workspace ONE Access instance. 83 | 84 | ```yaml 85 | Type: String 86 | Parameter Sets: (All) 87 | Aliases: 88 | 89 | Required: True 90 | Position: Named 91 | Default value: None 92 | Accept pipeline input: False 93 | Accept wildcard characters: False 94 | ``` 95 | 96 | ### -drift 97 | 98 | Switch to compare the current configuration against the product defaults or a JSON file. 99 | 100 | ```yaml 101 | Type: SwitchParameter 102 | Parameter Sets: (All) 103 | Aliases: 104 | 105 | Required: False 106 | Position: Named 107 | Default value: False 108 | Accept pipeline input: False 109 | Accept wildcard characters: False 110 | ``` 111 | 112 | ### -reportPath 113 | 114 | The path to save the policy report. 115 | 116 | ```yaml 117 | Type: String 118 | Parameter Sets: (All) 119 | Aliases: 120 | 121 | Required: False 122 | Position: Named 123 | Default value: None 124 | Accept pipeline input: False 125 | Accept wildcard characters: False 126 | ``` 127 | 128 | ### -policyFile 129 | 130 | The path to the policy configuration file. 131 | 132 | ```yaml 133 | Type: String 134 | Parameter Sets: (All) 135 | Aliases: 136 | 137 | Required: False 138 | Position: Named 139 | Default value: None 140 | Accept pipeline input: False 141 | Accept wildcard characters: False 142 | ``` 143 | 144 | ### Common Parameters 145 | 146 | 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). 147 | -------------------------------------------------------------------------------- /docs/documentation/functions/Start-PasswordPolicyConfig.md: -------------------------------------------------------------------------------- 1 | # Start-PasswordPolicyConfig 2 | 3 | ## Synopsis 4 | 5 | Configures all password policies. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Start-PasswordPolicyConfig -sddcManagerFqdn -sddcManagerUser -sddcManagerPass -sddcRootPass -reportPath -policyFile [-wsaFqdn ] [-wsaRootPass ] [-wsaAdminPass ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Start-PasswordPolicyConfig` configures the password policies across all components of the VMware Cloud Foundation instance using the JSON configuration file provided. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Start-PasswordPolicyConfig -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -sddcRootPass [root_password] -reportPath [report_path] -policyFile [policy_file].json 23 | ``` 24 | 25 | This examples configures all password policies for all components across a VMware Cloud Foundation instance. 26 | 27 | ### Example 2 28 | 29 | ```powershell 30 | Start-PasswordPolicyConfig -sddcManagerFqdn [sddc_manager_fqdn] -sddcManagerUser [admin_username] -sddcManagerPass [admin_password] -sddcRootPass [root_password] -reportPath [report_path] -policyFile [policy_file].json -wsaFqdn [wsa_fqdn] -wsaRootPass [wsa_root_password] -wsaAdminPass [wsa_admin_password] 31 | ``` 32 | 33 | This example configures all password policies for all components across a VMware Cloud Foundation instance and a Workspace ONE Access instance. 34 | 35 | ## Parameters 36 | 37 | ### -sddcManagerFqdn 38 | 39 | The fully qualified domain name of the SDDC Manager instance. 40 | 41 | ```yaml 42 | Type: String 43 | Parameter Sets: (All) 44 | Aliases: 45 | 46 | Required: True 47 | Position: Named 48 | Default value: None 49 | Accept pipeline input: False 50 | Accept wildcard characters: False 51 | ``` 52 | 53 | ### -sddcManagerUser 54 | 55 | The username to authenticate to the SDDC Manager instance. 56 | 57 | ```yaml 58 | Type: String 59 | Parameter Sets: (All) 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -sddcManagerPass 70 | 71 | The password to authenticate to the SDDC Manager instance. 72 | 73 | ```yaml 74 | Type: String 75 | Parameter Sets: (All) 76 | Aliases: 77 | 78 | Required: True 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -sddcRootPass 86 | 87 | The password for the SDDC Manager appliance root account. 88 | 89 | ```yaml 90 | Type: String 91 | Parameter Sets: (All) 92 | Aliases: 93 | 94 | Required: True 95 | Position: Named 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### -reportPath 102 | 103 | The path to save the policy report. 104 | 105 | ```yaml 106 | Type: String 107 | Parameter Sets: (All) 108 | Aliases: 109 | 110 | Required: True 111 | Position: Named 112 | Default value: None 113 | Accept pipeline input: False 114 | Accept wildcard characters: False 115 | ``` 116 | 117 | ### -policyFile 118 | 119 | The path to the JSON file containing the policy configuration. 120 | 121 | ```yaml 122 | Type: String 123 | Parameter Sets: (All) 124 | Aliases: 125 | 126 | Required: True 127 | Position: Named 128 | Default value: None 129 | Accept pipeline input: False 130 | Accept wildcard characters: False 131 | ``` 132 | 133 | ### -wsaFqdn 134 | 135 | The fully qualified domain name of the Workspace ONE Access instance. 136 | 137 | ```yaml 138 | Type: String 139 | Parameter Sets: (All) 140 | Aliases: 141 | 142 | Required: False 143 | Position: Named 144 | Default value: None 145 | Accept pipeline input: False 146 | Accept wildcard characters: False 147 | ``` 148 | 149 | ### -wsaRootPass 150 | 151 | The password for the Workspace ONE Access appliance root account. 152 | 153 | ```yaml 154 | Type: String 155 | Parameter Sets: (All) 156 | Aliases: 157 | 158 | Required: False 159 | Position: Named 160 | Default value: None 161 | Accept pipeline input: False 162 | Accept wildcard characters: False 163 | ``` 164 | 165 | ### -wsaAdminPass 166 | 167 | The password for the Workspace ONE Access admin account. 168 | 169 | ```yaml 170 | Type: String 171 | Parameter Sets: (All) 172 | Aliases: 173 | 174 | Required: False 175 | Position: Named 176 | Default value: None 177 | Accept pipeline input: False 178 | Accept wildcard characters: False 179 | ``` 180 | 181 | ### Common Parameters 182 | 183 | 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). 184 | -------------------------------------------------------------------------------- /docs/documentation/functions/Test-VcfPasswordManagementPrereq.md: -------------------------------------------------------------------------------- 1 | # Test-VcfPasswordManagementPrereq 2 | 3 | ## Synopsis 4 | 5 | Validate prerequisites to run the PowerShell module. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Test-VcfPasswordManagementPrereq 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Test-VcfPasswordManagementPrereq` cmdlet checks that all the prerequisites have been met to run the PowerShell module. 16 | 17 | ## Examples 18 | 19 | ### Example 1 20 | 21 | ```powershell 22 | Test-VcfPasswordManagementPrereq 23 | ``` 24 | 25 | This example runs the prerequisite validation. 26 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-EsxiAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Update-EsxiAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Updates the account lockout policy for all ESX hosts in a cluster. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-EsxiAccountLockout [-server] [-user] [-pass] [-domain] [-cluster] [-failures] [-unlockInterval] [[-detail] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-EsxiAccountLockout` cmdlet configures the account lockout policy on an ESX host. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that the workload domain exists in the SDDC Manager inventory 20 | - Validates that network connectivity and authentication is possible to vCenter 21 | - Gathers the ESX hosts for the cluster specified 22 | - Configures the account lockout policy for all ESX hosts in the cluster 23 | 24 | ## Examples 25 | 26 | ### Example 1 27 | 28 | ```powershell 29 | Update-EsxiAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -cluster [cluster_name] -failures 5 -unlockInterval 900 30 | ``` 31 | 32 | This example configures all ESX hosts within the cluster in the workload domain 33 | 34 | ### Example 2 35 | 36 | ```powershell 37 | Update-EsxiAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -cluster [cluster_name] -failures 5 -unlockInterval 900 -detail false 38 | ``` 39 | 40 | This example configures all ESX hosts within the cluster in the workload domain but does not show the detail per host. 41 | 42 | ## Parameters 43 | 44 | ### -server 45 | 46 | The fully qualified domain name of the SDDC Manager instance. 47 | 48 | ```yaml 49 | Type: String 50 | Parameter Sets: (All) 51 | Aliases: 52 | 53 | Required: True 54 | Position: 1 55 | Default value: None 56 | Accept pipeline input: False 57 | Accept wildcard characters: False 58 | ``` 59 | 60 | ### -user 61 | 62 | The username to authenticate to the SDDC Manager instance. 63 | 64 | ```yaml 65 | Type: String 66 | Parameter Sets: (All) 67 | Aliases: 68 | 69 | Required: True 70 | Position: 2 71 | Default value: None 72 | Accept pipeline input: False 73 | Accept wildcard characters: False 74 | ``` 75 | 76 | ### -pass 77 | 78 | The password to authenticate to the SDDC Manager instance. 79 | 80 | ```yaml 81 | Type: String 82 | Parameter Sets: (All) 83 | Aliases: 84 | 85 | Required: True 86 | Position: 3 87 | Default value: None 88 | Accept pipeline input: False 89 | Accept wildcard characters: False 90 | ``` 91 | 92 | ### -domain 93 | 94 | The name of the workload domain to update the policy for. 95 | 96 | ```yaml 97 | Type: String 98 | Parameter Sets: (All) 99 | Aliases: 100 | 101 | Required: True 102 | Position: 4 103 | Default value: None 104 | Accept pipeline input: False 105 | Accept wildcard characters: False 106 | ``` 107 | 108 | ### -cluster 109 | 110 | The name of the cluster to update the policy for. 111 | 112 | ```yaml 113 | Type: String 114 | Parameter Sets: (All) 115 | Aliases: 116 | 117 | Required: True 118 | Position: 5 119 | Default value: None 120 | Accept pipeline input: False 121 | Accept wildcard characters: False 122 | ``` 123 | 124 | ### -failures 125 | 126 | The number of failed login attempts before the account is locked. 127 | 128 | ```yaml 129 | Type: Int32 130 | Parameter Sets: (All) 131 | Aliases: 132 | 133 | Required: True 134 | Position: 6 135 | Default value: 0 136 | Accept pipeline input: False 137 | Accept wildcard characters: False 138 | ``` 139 | 140 | ### -unlockInterval 141 | 142 | The number of seconds before a locked out account is unlocked. 143 | 144 | ```yaml 145 | Type: Int32 146 | Parameter Sets: (All) 147 | Aliases: 148 | 149 | Required: True 150 | Position: 7 151 | Default value: 0 152 | Accept pipeline input: False 153 | Accept wildcard characters: False 154 | ``` 155 | 156 | ### -detail 157 | 158 | Return the details of the policy. 159 | One of true or false. 160 | Default is true. 161 | 162 | ```yaml 163 | Type: String 164 | Parameter Sets: (All) 165 | Aliases: 166 | 167 | Required: False 168 | Position: 8 169 | Default value: True 170 | Accept pipeline input: False 171 | Accept wildcard characters: False 172 | ``` 173 | 174 | ### Common Parameters 175 | 176 | 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). 177 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-EsxiPasswordComplexity.md: -------------------------------------------------------------------------------- 1 | # Update-EsxiPasswordComplexity 2 | 3 | ## Synopsis 4 | 5 | Updates the password complexity for all ESX hosts in a cluster. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-EsxiPasswordComplexity [-server] [-user] [-pass] [-domain] [-cluster] [-policy] [-history] [[-detail] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-EsxiPasswordComplexity` cmdlet configures the password complexity policy on an ESX host. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that the workload domain exists in the SDDC Manager inventory 20 | - Validates that network connectivity and authentication is possible to vCenter 21 | - Gathers the ESX hosts for the cluster specified 22 | - Configures the password complexity policy for all ESX hosts in the cluster 23 | 24 | ## Examples 25 | 26 | ### Example 1 27 | 28 | ```powershell 29 | Update-EsxiPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -cluster [cluster_name] -policy "retry=5 min=disabled,disabled,disabled,disabled,15" -history 5 30 | ``` 31 | 32 | This example configures all ESX hosts within the cluster in the workload domain 33 | 34 | ### Example 2 35 | 36 | ```powershell 37 | Update-EsxiPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -cluster [cluster_name] -policy "retry=5 min=disabled,disabled,disabled,disabled,15" -history 5 -detail false 38 | ``` 39 | 40 | This example configures all ESX hosts within the cluster in the workload domain but does not show the detail per host. 41 | 42 | ## Parameters 43 | 44 | ### -server 45 | 46 | The fully qualified domain name of the SDDC Manager instance. 47 | 48 | ```yaml 49 | Type: String 50 | Parameter Sets: (All) 51 | Aliases: 52 | 53 | Required: True 54 | Position: 1 55 | Default value: None 56 | Accept pipeline input: False 57 | Accept wildcard characters: False 58 | ``` 59 | 60 | ### -user 61 | 62 | The username to authenticate to the SDDC Manager instance. 63 | 64 | ```yaml 65 | Type: String 66 | Parameter Sets: (All) 67 | Aliases: 68 | 69 | Required: True 70 | Position: 2 71 | Default value: None 72 | Accept pipeline input: False 73 | Accept wildcard characters: False 74 | ``` 75 | 76 | ### -pass 77 | 78 | The password to authenticate to the SDDC Manager instance. 79 | 80 | ```yaml 81 | Type: String 82 | Parameter Sets: (All) 83 | Aliases: 84 | 85 | Required: True 86 | Position: 3 87 | Default value: None 88 | Accept pipeline input: False 89 | Accept wildcard characters: False 90 | ``` 91 | 92 | ### -domain 93 | 94 | The name of the workload domain to update the policy for. 95 | 96 | ```yaml 97 | Type: String 98 | Parameter Sets: (All) 99 | Aliases: 100 | 101 | Required: True 102 | Position: 4 103 | Default value: None 104 | Accept pipeline input: False 105 | Accept wildcard characters: False 106 | ``` 107 | 108 | ### -cluster 109 | 110 | The name of the cluster to update the policy for. 111 | 112 | ```yaml 113 | Type: String 114 | Parameter Sets: (All) 115 | Aliases: 116 | 117 | Required: True 118 | Position: 5 119 | Default value: None 120 | Accept pipeline input: False 121 | Accept wildcard characters: False 122 | ``` 123 | 124 | ### -policy 125 | 126 | The policy to apply to the ESX hosts. 127 | 128 | ```yaml 129 | Type: String 130 | Parameter Sets: (All) 131 | Aliases: 132 | 133 | Required: True 134 | Position: 6 135 | Default value: None 136 | Accept pipeline input: False 137 | Accept wildcard characters: False 138 | ``` 139 | 140 | ### -history 141 | 142 | The number of previous passwords that a password cannot match. 143 | 144 | ```yaml 145 | Type: Int32 146 | Parameter Sets: (All) 147 | Aliases: 148 | 149 | Required: True 150 | Position: 7 151 | Default value: 0 152 | Accept pipeline input: False 153 | Accept wildcard characters: False 154 | ``` 155 | 156 | ### -detail 157 | 158 | Return the details of the policy. 159 | One of true or false. 160 | Default is true. 161 | 162 | ```yaml 163 | Type: String 164 | Parameter Sets: (All) 165 | Aliases: 166 | 167 | Required: False 168 | Position: 8 169 | Default value: True 170 | Accept pipeline input: False 171 | Accept wildcard characters: False 172 | ``` 173 | 174 | ### Common Parameters 175 | 176 | 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). 177 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-EsxiPasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Update-EsxiPasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Updates the password expiration period in days for all ESX hosts in a cluster. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-EsxiPasswordExpiration [-server] [-user] [-pass] [-domain] [-cluster] [-maxDays] [[-detail] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-EsxiPasswordExpiration` cmdlet configures the password expiration policy on an ESX host. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that the workload domain exists in the SDDC Manager inventory 20 | - Validates that network connectivity and authentication is possible to vCenter 21 | - Gathers the ESX hosts for the cluster specified 22 | - Configures the password expiration policy for all ESX hosts in the cluster 23 | 24 | ## Examples 25 | 26 | ### Example 1 27 | 28 | ```powershell 29 | Update-EsxiPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -cluster [cluster_name] -maxDays 999 30 | ``` 31 | 32 | This example configures all ESX hosts within the cluster named in the workload domain. 33 | 34 | ### Example 2 35 | 36 | ```powershell 37 | Update-EsxiPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -cluster [cluster_name] -maxDays 999 -detail false 38 | ``` 39 | 40 | This example configures all ESX hosts within the cluster named in the workload domain but does not show the detail per host. 41 | 42 | ## Parameters 43 | 44 | ### -server 45 | 46 | The fully qualified domain name of the SDDC Manager instance. 47 | 48 | ```yaml 49 | Type: String 50 | Parameter Sets: (All) 51 | Aliases: 52 | 53 | Required: True 54 | Position: 1 55 | Default value: None 56 | Accept pipeline input: False 57 | Accept wildcard characters: False 58 | ``` 59 | 60 | ### -user 61 | 62 | The username to authenticate to the SDDC Manager instance. 63 | 64 | ```yaml 65 | Type: String 66 | Parameter Sets: (All) 67 | Aliases: 68 | 69 | Required: True 70 | Position: 2 71 | Default value: None 72 | Accept pipeline input: False 73 | Accept wildcard characters: False 74 | ``` 75 | 76 | ### -pass 77 | 78 | The password to authenticate to the SDDC Manager instance. 79 | 80 | ```yaml 81 | Type: String 82 | Parameter Sets: (All) 83 | Aliases: 84 | 85 | Required: True 86 | Position: 3 87 | Default value: None 88 | Accept pipeline input: False 89 | Accept wildcard characters: False 90 | ``` 91 | 92 | ### -domain 93 | 94 | The name of the workload domain to update the policy for. 95 | 96 | ```yaml 97 | Type: String 98 | Parameter Sets: (All) 99 | Aliases: 100 | 101 | Required: True 102 | Position: 4 103 | Default value: None 104 | Accept pipeline input: False 105 | Accept wildcard characters: False 106 | ``` 107 | 108 | ### -cluster 109 | 110 | The name of the cluster to update the policy for. 111 | 112 | ```yaml 113 | Type: String 114 | Parameter Sets: (All) 115 | Aliases: 116 | 117 | Required: True 118 | Position: 5 119 | Default value: None 120 | Accept pipeline input: False 121 | Accept wildcard characters: False 122 | ``` 123 | 124 | ### -maxDays 125 | 126 | The maximum number of days before the password expires. 127 | 128 | ```yaml 129 | Type: String 130 | Parameter Sets: (All) 131 | Aliases: 132 | 133 | Required: True 134 | Position: 6 135 | Default value: None 136 | Accept pipeline input: False 137 | Accept wildcard characters: False 138 | ``` 139 | 140 | ### -detail 141 | 142 | Return the details of the policy. 143 | One of true or false. 144 | Default is true. 145 | 146 | ```yaml 147 | Type: String 148 | Parameter Sets: (All) 149 | Aliases: 150 | 151 | Required: False 152 | Position: 7 153 | Default value: True 154 | Accept pipeline input: False 155 | Accept wildcard characters: False 156 | ``` 157 | 158 | ### Common Parameters 159 | 160 | 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). 161 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-NsxtEdgeAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Update-NsxtEdgeAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Updates the account lockout policy for NSX Edge nodes. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-NsxtEdgeAccountLockout [-server] [-user] [-pass] [-domain] [[-cliFailures] ] [[-cliUnlockInterval] ] [[-detail] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-NsxtEdgeAccountLockout` cmdlet configures the account lockout policy for NSX Edge nodes. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to NSX Local Manager 20 | - Configure the account lockout policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Update-NsxtEdgeAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -cliFailures 5 -cliUnlockInterval 900 28 | ``` 29 | 30 | This example configures the account lockout policy of the NSX Edge nodes in the workload domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager instance. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to retrieve the policy from. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -cliFailures 99 | 100 | The number of failed login attempts before the account is locked for the CLI. 101 | 102 | ```yaml 103 | Type: Int32 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: False 108 | Position: 5 109 | Default value: 0 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -cliUnlockInterval 115 | 116 | The number of seconds before the account is unlocked for the CLI. 117 | 118 | ```yaml 119 | Type: Int32 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: 6 125 | Default value: 0 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -detail 131 | 132 | Return the details of the policy. 133 | One of true or false. 134 | Default is true. 135 | 136 | ```yaml 137 | Type: String 138 | Parameter Sets: (All) 139 | Aliases: 140 | 141 | Required: False 142 | Position: 7 143 | Default value: True 144 | Accept pipeline input: False 145 | Accept wildcard characters: False 146 | ``` 147 | 148 | ### Common Parameters 149 | 150 | 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). 151 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-NsxtEdgePasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Update-NsxtEdgePasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Updates the local user password expiration policy for NSX Edge node local users. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-NsxtEdgePasswordExpiration [-server] [-user] [-pass] [-domain] [-maxDays] [[-detail] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-NsxtEdgePasswordExpiration` cmdlet configures the password expiration policy for NSX Edge node local users for a workload domain. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to NSX Local Manager 20 | - Updates the password expiration policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Update-NsxtEdgePasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -maxdays 999 28 | ``` 29 | 30 | This example configures the password expiration policy for all NSX Edge node local users in the workload domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager instance. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to retrieve the policy from. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -maxDays 99 | 100 | The maximum number of days before the password expires. 101 | 102 | ```yaml 103 | Type: Int32 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: 5 109 | Default value: 0 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -detail 115 | 116 | Return the details of the policy. 117 | One of true or false. 118 | Default is true. 119 | 120 | ```yaml 121 | Type: String 122 | Parameter Sets: (All) 123 | Aliases: 124 | 125 | Required: False 126 | Position: 6 127 | Default value: True 128 | Accept pipeline input: False 129 | Accept wildcard characters: False 130 | ``` 131 | 132 | ### Common Parameters 133 | 134 | 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). 135 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-NsxtManagerPasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Update-NsxtManagerPasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Updates the password expiration policy for NSX Local Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-NsxtManagerPasswordExpiration [-server] [-user] [-pass] [-domain] [-maxDays] [[-detail] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-NsxtManagerPasswordExpiration` cmdlet configures the password expiration policy for NSX Local Manager local users for a workload domain. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to NSX Local Manager 20 | - Updates the password expiration policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Update-NsxtManagerPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -maxdays 999 28 | ``` 29 | 30 | This example configures the password expiration policy in NSX Local Manager for all local users in the workload domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager instance. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to update the policy for. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -maxDays 99 | 100 | The maximum number of days that a password is valid for. 101 | 102 | ```yaml 103 | Type: Int32 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: 5 109 | Default value: 0 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -detail 115 | 116 | Return the details of the policy. 117 | One of true or false. 118 | Default is true. 119 | 120 | ```yaml 121 | Type: String 122 | Parameter Sets: (All) 123 | Aliases: 124 | 125 | Required: False 126 | Position: 6 127 | Default value: True 128 | Accept pipeline input: False 129 | Accept wildcard characters: False 130 | ``` 131 | 132 | ### Common Parameters 133 | 134 | 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). 135 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-SddcManagerAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Update-SddcManagerAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Updates the account lockout policy for an SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-SddcManagerAccountLockout [-server] [-user] [-pass] [-rootPass] [-failures] [[-unlockInterval] ] [[-rootUnlockInterval] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-SddcManagerAccountLockout` cmdlet configures the account lockout policy for an SDDC Manager. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Configures the account lockout policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Update-SddcManagerAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -rootPass [root_password] -failures 3 -unlockInterval 86400 -rootUnlockInterval 300 28 | ``` 29 | 30 | This example configures the account lockout policy for an SDDC Manager. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager instance. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -rootPass 83 | 84 | The password for the SDDC Manager appliance root account. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -failures 99 | 100 | The number of failed login attempts before the account is locked. 101 | 102 | ```yaml 103 | Type: Int32 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: 5 109 | Default value: 0 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -unlockInterval 115 | 116 | The number of seconds before a locked account is unlocked. 117 | 118 | ```yaml 119 | Type: Int32 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: 6 125 | Default value: 0 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -rootUnlockInterval 131 | 132 | The number of seconds before a locked root account is unlocked. 133 | 134 | ```yaml 135 | Type: Int32 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: 7 141 | Default value: 0 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### Common Parameters 147 | 148 | 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). 149 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-SddcManagerPasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Update-SddcManagerPasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Updates the password expiration policy for an SDDC Manager. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-SddcManagerPasswordExpiration [-server] [-user] [-pass] [-rootPass] [-minDays] [-maxDays] [-warnDays] [[-detail] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-SddcManagerPasswordExpiration` cmdlet configures the password expiration policy for an SDDC Manager. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Configures the password expiration policy 20 | 21 | ## Examples 22 | 23 | ### Example 1 24 | 25 | ```powershell 26 | Update-SddcManagerPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -rootPass [root_password] -minDays 0 -maxDays 90 -warnDays 14 27 | ``` 28 | 29 | This example updates the password expiration policy for the default local users on an SDDC Manager. 30 | 31 | ## Parameters 32 | 33 | ### -server 34 | 35 | The fully qualified domain name of the SDDC Manager instance. 36 | 37 | ```yaml 38 | Type: String 39 | Parameter Sets: (All) 40 | Aliases: 41 | 42 | Required: True 43 | Position: 1 44 | Default value: None 45 | Accept pipeline input: False 46 | Accept wildcard characters: False 47 | ``` 48 | 49 | ### -user 50 | 51 | The username to authenticate to the SDDC Manager instance. 52 | 53 | ```yaml 54 | Type: String 55 | Parameter Sets: (All) 56 | Aliases: 57 | 58 | Required: True 59 | Position: 2 60 | Default value: None 61 | Accept pipeline input: False 62 | Accept wildcard characters: False 63 | ``` 64 | 65 | ### -pass 66 | 67 | The password to authenticate to the SDDC Manager instance. 68 | 69 | ```yaml 70 | Type: String 71 | Parameter Sets: (All) 72 | Aliases: 73 | 74 | Required: True 75 | Position: 3 76 | Default value: None 77 | Accept pipeline input: False 78 | Accept wildcard characters: False 79 | ``` 80 | 81 | ### -rootPass 82 | 83 | The password for the SDDC Manager appliance root account. 84 | 85 | ```yaml 86 | Type: String 87 | Parameter Sets: (All) 88 | Aliases: 89 | 90 | Required: True 91 | Position: 4 92 | Default value: None 93 | Accept pipeline input: False 94 | Accept wildcard characters: False 95 | ``` 96 | 97 | ### -minDays 98 | 99 | The minimum number of days before the password expires. 100 | 101 | ```yaml 102 | Type: Int32 103 | Parameter Sets: (All) 104 | Aliases: 105 | 106 | Required: True 107 | Position: 5 108 | Default value: 0 109 | Accept pipeline input: False 110 | Accept wil 111 | 112 | ### -maxDays 113 | 114 | The maximum number of days before the password expires. 115 | 116 | ```yaml 117 | Type: Int32 118 | Parameter Sets: (All) 119 | Aliases: 120 | 121 | Required: True 122 | Position: 5 123 | Default value: 0 124 | Accept pipeline input: False 125 | Accept wildcard characters: False 126 | ``` 127 | 128 | ### -detail 129 | 130 | Return the details of the policy. 131 | One of true or false. 132 | Default is true. 133 | 134 | ```yaml 135 | Type: String 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: 6 141 | Default value: True 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### Common Parameters 147 | 148 | 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). 149 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-SsoAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Update-SsoAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Updates the account lockout policy for a vCenter Single Sign-On domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-SsoAccountLockout [-server] [-user] [-pass] [-domain] [-failures] [-failureInterval] [-unlockInterval] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-SsoAccountLockout` cmdlet configures the account lockout policy of a vCenter Single Sign-On domain. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Configures the vCenter Single Sign-On account lockout policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Update-SsoAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failures 5 -failureInterval 180 -unlockInterval 900 28 | ``` 29 | 30 | This example configures the account lockout policy for a vCenter Single Sign-On domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager instance. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to update the policy for. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -failures 99 | 100 | The number of failed login attempts before the account is locked. 101 | 102 | ```yaml 103 | Type: Int32 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: 5 109 | Default value: 0 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -failureInterval 115 | 116 | The number of seconds before the failed login attempts counter is reset. 117 | 118 | ```yaml 119 | Type: Int32 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: True 124 | Position: 6 125 | Default value: 0 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -unlockInterval 131 | 132 | The number of seconds before a locked account is unlocked. 133 | 134 | ```yaml 135 | Type: Int32 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: True 140 | Position: 7 141 | Default value: 0 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### Common Parameters 147 | 148 | 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). 149 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-SsoPasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Update-SsoPasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Updates the password expiration policy for a vCenter Single Sign-On domain. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-SsoPasswordExpiration [-server] [-user] [-pass] [-domain] [-maxDays] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-SsoPasswordExpiration` cmdlet configures the password expiration policy for a vCenter Single Sign-On domain. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Configures the vCenter Single Sign-On password expiration policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Update-SsoPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -maxDays 999 28 | ``` 29 | 30 | This example configures the password expiration policy for a vCenter Single Sign-On domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager instance. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to update the policy for. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -maxDays 99 | 100 | The maximum number of days that a password is valid for. 101 | 102 | ```yaml 103 | Type: Int32 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: 5 109 | Default value: 0 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### Common Parameters 115 | 116 | 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). 117 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-VcenterAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Update-VcenterAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Updates the account lockout policy for a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-VcenterAccountLockout [-server] [-user] [-pass] [-domain] [-failures] [[-unlockInterval] ] [[-rootUnlockInterval] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-VcenterAccountLockout` cmdlet configures the account lockout policy of a vCenter instance. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Configures the account lockout policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Update-VcenterAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -failures 3 -unlockInterval 900 -rootUnlockInterval 300 28 | ``` 29 | 30 | This example configures the account lockout policy for a vCenter instance based on the workload domain. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager instance. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to update the policy for. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -failures 99 | 100 | The number of failed login attempts before the account is locked. 101 | 102 | ```yaml 103 | Type: Int32 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: 5 109 | Default value: 0 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -unlockInterval 115 | 116 | The number of seconds before a locked out account is unlocked. 117 | 118 | ```yaml 119 | Type: Int32 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: False 124 | Position: 6 125 | Default value: 0 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -rootUnlockInterval 131 | 132 | The number of seconds before a locked out root account is unlocked. 133 | 134 | ```yaml 135 | Type: Int32 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: 7 141 | Default value: 0 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### Common Parameters 147 | 148 | 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). 149 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-VcenterPasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Update-VcenterPasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Updates the global password expiration policy for a vCenter instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-VcenterPasswordExpiration [-server] [-user] [-pass] [-domain] [-maxDays] [-minDays] [-warnDays] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-VcenterPasswordExpiration` cmdlet configures the global password expiration policy of a vCenter instance. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Configures the global password expiration policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Update-VcenterPasswordExpiration -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -domain [workload_domain_name] -maxDays 999 -minDays 0 -warnDays 14 28 | ``` 29 | 30 | This example configures the global password expiration policy for a vCenter instance. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager instance. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -domain 83 | 84 | The name of the workload domain to update the policy for. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -maxDays 99 | 100 | The maximum number of days that a password is valid. 101 | 102 | ```yaml 103 | Type: Int32 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: 5 109 | Default value: 0 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -minDays 115 | 116 | The minimum number of days that a password is valid. 117 | 118 | ```yaml 119 | Type: Int32 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: True 124 | Position: 6 125 | Default value: 0 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -warnDays 131 | 132 | The number of days before a password expires that a warning is issued. 133 | 134 | ```yaml 135 | Type: Int32 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: True 140 | Position: 7 141 | Default value: 0 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### Common Parameters 147 | 148 | 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). 149 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-WsaAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Update-WsaAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Updates the account lockout policy for a Workspace ONE Access instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-WsaAccountLockout [-server] [-user] [-pass] [-failures] [-failureInterval] [-unlockInterval] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-WsaAccountLockout` cmdlet configures the account lockout policy for Workspace ONE Access. 16 | 17 | - Validates that network connectivity and authentication is possible to Workspace ONE Access 18 | - Configures the Workspace ONE Access account lockout policy 19 | 20 | ## Examples 21 | 22 | ### Example 1 23 | 24 | ```powershell 25 | Update-WsaAccountLockout -server [wsa_fqdn] -user [admin_username] -pass [admin_password] -failures 5 -failureInterval 180 -unlockInterval 900 26 | ``` 27 | 28 | This example configures the account lockout policy for Workspace ONE Access. 29 | 30 | ## Parameters 31 | 32 | ### -server 33 | 34 | The fully qualified domain name of the Workspace ONE Access instance. 35 | 36 | ```yaml 37 | Type: String 38 | Parameter Sets: (All) 39 | Aliases: 40 | 41 | Required: True 42 | Position: 1 43 | Default value: None 44 | Accept pipeline input: False 45 | Accept wildcard characters: False 46 | ``` 47 | 48 | ### -user 49 | 50 | The username to authenticate to the Workspace ONE Access instance. 51 | 52 | ```yaml 53 | Type: String 54 | Parameter Sets: (All) 55 | Aliases: 56 | 57 | Required: True 58 | Position: 2 59 | Default value: None 60 | Accept pipeline input: False 61 | Accept wildcard characters: False 62 | ``` 63 | 64 | ### -pass 65 | 66 | The password to authenticate to the Workspace ONE Access instance. 67 | 68 | ```yaml 69 | Type: String 70 | Parameter Sets: (All) 71 | Aliases: 72 | 73 | Required: True 74 | Position: 3 75 | Default value: None 76 | Accept pipeline input: False 77 | Accept wildcard characters: False 78 | ``` 79 | 80 | ### -failures 81 | 82 | The number of failed login attempts before the account is locked. 83 | 84 | ```yaml 85 | Type: Int32 86 | Parameter Sets: (All) 87 | Aliases: 88 | 89 | Required: True 90 | Position: 4 91 | Default value: 0 92 | Accept pipeline input: False 93 | Accept wildcard characters: False 94 | ``` 95 | 96 | ### -failureInterval 97 | 98 | The number of seconds before the failed login attempts counter is reset. 99 | 100 | ```yaml 101 | Type: Int32 102 | Parameter Sets: (All) 103 | Aliases: 104 | 105 | Required: True 106 | Position: 5 107 | Default value: 0 108 | Accept pipeline input: False 109 | Accept wildcard characters: False 110 | ``` 111 | 112 | ### -unlockInterval 113 | 114 | The number of seconds before a locked account is unlocked. 115 | 116 | ```yaml 117 | Type: Int32 118 | Parameter Sets: (All) 119 | Aliases: 120 | 121 | Required: True 122 | Position: 6 123 | Default value: 0 124 | Accept pipeline input: False 125 | Accept wildcard characters: False 126 | ``` 127 | 128 | ### Common Parameters 129 | 130 | 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). 131 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-WsaLocalUserAccountLockout.md: -------------------------------------------------------------------------------- 1 | # Update-WsaLocalUserAccountLockout 2 | 3 | ## Synopsis 4 | 5 | Updates the account lockout policy of Workspace ONE Access. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-WsaLocalUserAccountLockout [-server] [-user] [-pass] [-wsaFqdn] [-wsaRootPass] [-failures] [[-unlockInterval] ] [[-rootUnlockInterval] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-WsaLocalUserAccountLockout` cmdlet configures the account lockout policy of Workspace ONE Access. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Configures the account lockout policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Update-WsaLocalUserAccountLockout -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -wsaFqdn [wsa_fqdn] -wsaRootPass [wsa_root_password] -failures 3 -unlockInterval 900 -rootUnlockInterval 900 28 | ``` 29 | 30 | This example configures the account lockout policy for Workspace ONE Access. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager instance. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -wsaFqdn 83 | 84 | The fully qualified domain name of the Workspace ONE Access instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -wsaRootPass 99 | 100 | The password for the Workspace ONE Access appliance root account. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: 5 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -failures 115 | 116 | The number of failed login attempts before the account is locked. 117 | 118 | ```yaml 119 | Type: Int32 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: True 124 | Position: 6 125 | Default value: 0 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -unlockInterval 131 | 132 | The number of seconds before a locked account is unlocked. 133 | 134 | ```yaml 135 | Type: Int32 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: 7 141 | Default value: 0 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -rootUnlockInterval 147 | 148 | The number of seconds before a locked root account is unlocked. 149 | 150 | ```yaml 151 | Type: Int32 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: 8 157 | Default value: 0 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-WsaLocalUserPasswordComplexity.md: -------------------------------------------------------------------------------- 1 | # Update-WsaLocalUserPasswordComplexity 2 | 3 | ## Synopsis 4 | 5 | Updates the local user password complexity policy for Workspace ONE Access. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-WsaLocalUserPasswordComplexity [-server] [-user] [-pass] [-wsaFqdn] [-wsaRootPass] [-minLength] [[-history] ] [[-maxRetry] ] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-WsaLocalUserPasswordComplexity` cmdlet configures the local user password complexity policy for Workspace ONE Access. 16 | The cmdlet connects to SDDC Manager using the `-server`, `-user`, and `-pass` values: 17 | 18 | - Validates that network connectivity and authentication is possible to SDDC Manager 19 | - Validates that network connectivity and authentication is possible to vCenter 20 | - Configures the password complexity policy 21 | 22 | ## Examples 23 | 24 | ### Example 1 25 | 26 | ```powershell 27 | Update-WsaLocalUserPasswordComplexity -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -wsaFqdn [wsa_fqdn] -wsaRootPass [wsa_root_password] -minLength 1 -history 5 -maxRetry 3 28 | ``` 29 | 30 | This example configures the local user password complexity policy for Workspace ONE Access. 31 | 32 | ## Parameters 33 | 34 | ### -server 35 | 36 | The fully qualified domain name of the SDDC Manager instance. 37 | 38 | ```yaml 39 | Type: String 40 | Parameter Sets: (All) 41 | Aliases: 42 | 43 | Required: True 44 | Position: 1 45 | Default value: None 46 | Accept pipeline input: False 47 | Accept wildcard characters: False 48 | ``` 49 | 50 | ### -user 51 | 52 | The username to authenticate to the SDDC Manager instance. 53 | 54 | ```yaml 55 | Type: String 56 | Parameter Sets: (All) 57 | Aliases: 58 | 59 | Required: True 60 | Position: 2 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### -pass 67 | 68 | The password to authenticate to the SDDC Manager instance. 69 | 70 | ```yaml 71 | Type: String 72 | Parameter Sets: (All) 73 | Aliases: 74 | 75 | Required: True 76 | Position: 3 77 | Default value: None 78 | Accept pipeline input: False 79 | Accept wildcard characters: False 80 | ``` 81 | 82 | ### -wsaFqdn 83 | 84 | The fully qualified domain name of the Workspace ONE Access instance. 85 | 86 | ```yaml 87 | Type: String 88 | Parameter Sets: (All) 89 | Aliases: 90 | 91 | Required: True 92 | Position: 4 93 | Default value: None 94 | Accept pipeline input: False 95 | Accept wildcard characters: False 96 | ``` 97 | 98 | ### -wsaRootPass 99 | 100 | The password for the Workspace ONE Access appliance root account. 101 | 102 | ```yaml 103 | Type: String 104 | Parameter Sets: (All) 105 | Aliases: 106 | 107 | Required: True 108 | Position: 5 109 | Default value: None 110 | Accept pipeline input: False 111 | Accept wildcard characters: False 112 | ``` 113 | 114 | ### -minLength 115 | 116 | The minimum length of the password. 117 | 118 | ```yaml 119 | Type: Int32 120 | Parameter Sets: (All) 121 | Aliases: 122 | 123 | Required: True 124 | Position: 6 125 | Default value: 0 126 | Accept pipeline input: False 127 | Accept wildcard characters: False 128 | ``` 129 | 130 | ### -history 131 | 132 | The number of previous passwords that a password cannot match. 133 | 134 | ```yaml 135 | Type: Int32 136 | Parameter Sets: (All) 137 | Aliases: 138 | 139 | Required: False 140 | Position: 7 141 | Default value: 0 142 | Accept pipeline input: False 143 | Accept wildcard characters: False 144 | ``` 145 | 146 | ### -maxRetry 147 | 148 | The number of failed login attempts before the account is locked. 149 | 150 | ```yaml 151 | Type: Int32 152 | Parameter Sets: (All) 153 | Aliases: 154 | 155 | Required: False 156 | Position: 8 157 | Default value: 0 158 | Accept pipeline input: False 159 | Accept wildcard characters: False 160 | ``` 161 | 162 | ### Common Parameters 163 | 164 | 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). 165 | -------------------------------------------------------------------------------- /docs/documentation/functions/Update-WsaPasswordExpiration.md: -------------------------------------------------------------------------------- 1 | # Update-WsaPasswordExpiration 2 | 3 | ## Synopsis 4 | 5 | Updates the password expiration policy for Workspace ONE Access instance. 6 | 7 | ## Syntax 8 | 9 | ```powershell 10 | Update-WsaPasswordExpiration [-server] [-user] [-pass] [-maxDays] [-warnDays] [-reminderDays] [-tempPasswordHours] [] 11 | ``` 12 | 13 | ## Description 14 | 15 | The `Update-WsaPasswordExpiration` cmdlet configures the password expiration policy for a Workspace ONE Access instance. 16 | 17 | - Validates that network connectivity and authentication is possible to Workspace ONE Access 18 | - Configures the Workspace ONE Access password expiration policy 19 | 20 | ## Examples 21 | 22 | ### Example 1 23 | 24 | ```powershell 25 | Update-WsaPasswordExpiration -server [wsa_fqdn] -user [admin_username] -pass [admin_password] -maxDays 999 -warnDays 14 -reminderDays 7 -tempPasswordHours 24 26 | ``` 27 | 28 | This example configures the password expiration policy for Workspace ONE Access. 29 | 30 | ## Parameters 31 | 32 | ### -server 33 | 34 | The fully qualified domain name of the Workspace ONE Access instance. 35 | 36 | ```yaml 37 | Type: String 38 | Parameter Sets: (All) 39 | Aliases: 40 | 41 | Required: True 42 | Position: 1 43 | Default value: None 44 | Accept pipeline input: False 45 | Accept wildcard characters: False 46 | ``` 47 | 48 | ### -user 49 | 50 | The username to authenticate to the Workspace ONE Access instance. 51 | 52 | ```yaml 53 | Type: String 54 | Parameter Sets: (All) 55 | Aliases: 56 | 57 | Required: True 58 | Position: 2 59 | Default value: None 60 | Accept pipeline input: False 61 | Accept wildcard characters: False 62 | ``` 63 | 64 | ### -pass 65 | 66 | The password to authenticate to the Workspace ONE Access instance. 67 | 68 | ```yaml 69 | Type: String 70 | Parameter Sets: (All) 71 | Aliases: 72 | 73 | Required: True 74 | Position: 3 75 | Default value: None 76 | Accept pipeline input: False 77 | Accept wildcard characters: False 78 | ``` 79 | 80 | ### -maxDays 81 | 82 | The maximum number of days that a password is valid. 83 | 84 | ```yaml 85 | Type: Int32 86 | Parameter Sets: (All) 87 | Aliases: 88 | 89 | Required: True 90 | Position: 4 91 | Default value: 0 92 | Accept pipeline input: False 93 | Accept wildcard characters: False 94 | ``` 95 | 96 | ### -warnDays 97 | 98 | The number of days before a password expires that a warning is issued. 99 | 100 | ```yaml 101 | Type: Int32 102 | Parameter Sets: (All) 103 | Aliases: 104 | 105 | Required: True 106 | Position: 5 107 | Default value: 0 108 | Accept pipeline input: False 109 | Accept wildcard characters: False 110 | ``` 111 | 112 | ### -reminderDays 113 | 114 | The number of days before a password expires that a reminder is issued. 115 | 116 | ```yaml 117 | Type: Int32 118 | Parameter Sets: (All) 119 | Aliases: 120 | 121 | Required: True 122 | Position: 6 123 | Default value: 0 124 | Accept pipeline input: False 125 | Accept wildcard characters: False 126 | ``` 127 | 128 | ### -tempPasswordHours 129 | 130 | The number of hours that a temporary password is valid. 131 | 132 | ```yaml 133 | Type: Int32 134 | Parameter Sets: (All) 135 | Aliases: 136 | 137 | Required: True 138 | Position: 7 139 | Default value: 0 140 | Accept pipeline input: False 141 | Accept wildcard characters: False 142 | ``` 143 | 144 | ### Common Parameters 145 | 146 | 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). 147 | -------------------------------------------------------------------------------- /docs/documentation/index.md: -------------------------------------------------------------------------------- 1 | 2 | # Reference 3 | 4 | `VMware.CloudFoundation.PasswordManagement` is a PowerShell module designed to help you report on 5 | and manage password policy settings within your VMware Cloud Foundation environment. 6 | 7 | Using this module, you can perform various tasks on a VMware Cloud Foundation instance or a specific 8 | workload domain. 9 | 10 | The module provides coverage for the following: 11 | 12 | === ":material-shield-check:   Password Policies" 13 | 14 | 1. Generate detailed password policy reports, including information on password expiration, complexity, and account lockout settings. 15 | 2. Identify configuration drift by generating password policy reports using a predefined configuration file. 16 | 3. Update password policies seamlessly using a password policy configuration file. 17 | 4. Create comprehensive password rotation reports for all accounts managed by SDDC Manager. 18 | 19 | Components: 20 | 21 | * VMware SDDC Manager 22 | * VMware vCenter Single Sign-On 23 | * VMware vCenter 24 | * VMware ESX 25 | * VMware NSX Local Manager 26 | * VMware NSX Edge 27 | * VMware Aria Suite Lifecycle 28 | * VMware Aria Operations 29 | * VMware Aria Operations for Logs 30 | * VMware Aria Operations for Networks 31 | * VMware Aria Automation 32 | * VMware Workspace ONE Access 33 | 34 | === ":fontawesome-solid-rotate:   Password Rotation" 35 | 36 | Generate a password rotation report for accounts managed by SDDC Manager. 37 | 38 | Components: 39 | 40 | * VMware SDDC Manager 41 | * VMware vCenter Single Sign-On 42 | * VMware vCenter 43 | * VMware NSX Local Manager 44 | * VMware NSX Edge 45 | * VMware Aria Suite Lifecycle 46 | * VMware Aria Operations 47 | * VMware Aria Operations for Logs 48 | * VMware Aria Automation 49 | * VMware Workspace ONE Access 50 | 51 | ???+ note "Note" 52 | - VMware ESX password rotation is not managed by SDDC Manager. 53 | - VMware Aria Suite password rotation is only supported if deployed in VMware Cloud Foundation mode and present in the SDDC Manager inventory. 54 | -------------------------------------------------------------------------------- /docs/documentation/testing/index.md: -------------------------------------------------------------------------------- 1 | # Testing the PowerShell Module with Pester 2 | 3 | ## Overview 4 | 5 | Pester is a testing and mocking framework for PowerShell, most commonly used for writing unit and integration tests. 6 | 7 | This project uses Pester integration test cases for testing the functionality of the modules functions both for the developer and in a CI/CD pipeline environment. 8 | 9 | These Pester test cases allow for the verification of functions such as `Request-*` and `Update-*`, ensuring they function correctly during development. 10 | 11 | This proactive approach helps catch regression issues before a release. 12 | 13 | ## Getting Started 14 | 15 | ???+ tip "Logs" 16 | 17 | A `./tests/logs` folder is provided, containing a log file that records detailed information about the testing process. 18 | 19 | 1. Clone the repository: 20 | 21 | ```bash 22 | git clone https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management.git 23 | ``` 24 | 25 | 2. Navigate to the downloaded repository: 26 | 27 | ```bash 28 | cd powershell-module-for-vmware-cloud-foundation-password-management 29 | ``` 30 | 31 | 3. Verify all the required module dependencies are imported and then import the module: 32 | 33 | ```powershell 34 | --8<-- "./docs/snippets/import-module-tests.ps1" 35 | ``` 36 | 37 | 4. Navigate to the `tests` directory: 38 | 39 | ```bash 40 | cd tests 41 | ``` 42 | 43 | 5. Under the `tests` folder, copy the `inputData.json.example` file to `inputData.json` and include information about your testbed. 44 | 45 | This file serves as an input file to run tests against a VMware Cloud Foundation **development** environment. 46 | 47 | 6. Run all Pester test cases in a file with the following command: 48 | 49 | ```powershell 50 | Invoke-Pester ".\PPM.Tests.ps1" 51 | ``` 52 | 53 | 7. There are positive and negative test cases for each policy. If you want to run only one policy, use the tag associated with the policy: 54 | 55 | ```powershell 56 | Invoke-Pester -Path ".\PPM.Tests.ps1" -Tag "NSXEdgeAccountLockout" 57 | ``` 58 | 59 | 8. To run only positive test cases for a policy, provide the name for the `-Tag` and use the `-ExcludeTag` with the tag `"Negative"`: 60 | 61 | ```powershell 62 | Invoke-Pester -Path ".\PPM.Tests.ps1" -Tag "NSXEdgeAccountLockout" -ExcludeTag "Negative" 63 | ``` 64 | 65 | 9. To see detailed output of the run, which includes information on which test cases are started, their status, and so on, use the following option: 66 | 67 | ```powershell 68 | Invoke-Pester -Path ".\PPM.Tests.ps1" -Output Detailed 69 | ``` 70 | -------------------------------------------------------------------------------- /docs/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/71f1331758d40cdff7de7078c68d539820017ad0/docs/favicon.ico -------------------------------------------------------------------------------- /docs/install.md: -------------------------------------------------------------------------------- 1 | # Installing the Module 2 | 3 | Verify that your system has a [supported edition and version](index.md#powershell) of PowerShell installed. 4 | 5 | === ":material-pipe:   Connected Environment" 6 | 7 | For environments connected to the Internet, you can install the [module dependencies](index.md#module-dependencies) from the PowerShell Gallery by running the following commands in the PowerShell console: 8 | 9 | ```powershell 10 | --8<-- "./docs/snippets/install-module.ps1" 11 | ``` 12 | 13 | Import the modules before proceeding: 14 | 15 | For example: 16 | 17 | ```powershell 18 | --8<-- "./docs/snippets/import-module.ps1" 19 | ``` 20 | 21 | To verify the module dependencies are installed, run the following commands in the PowerShell console. 22 | 23 | **Example**: 24 | 25 | ```powershell 26 | Test-VcfPasswordManagementPrereq 27 | ``` 28 | 29 | === ":material-pipe-disconnected:   Disconnected Environment" 30 | 31 | For environments disconnected from the Internet _(e.g., dark-site, air-gapped)_, you can save the [module dependencies](index.md#module-dependencies) from the PowerShell Gallery by running the following commands in the PowerShell console: 32 | 33 | === ":fontawesome-brands-windows:   Windows" 34 | 35 | From a system with an Internet connection, save the module dependencies from the PowerShell Gallery by running the following commands in the PowerShell console: 36 | 37 | ```powershell 38 | --8<-- "./docs/snippets/save-module-local-windows.ps1" 39 | ``` 40 | 41 | From the system with the Internet connection, copy the module dependencies to a target system by running the following commands in the PowerShell console: 42 | 43 | ```powershell 44 | --8<-- "./docs/snippets/copy-module-local-windows.ps1" 45 | ``` 46 | 47 | On the target system, import the module dependencies by running the following commands in the PowerShell console: 48 | 49 | ```powershell 50 | --8<-- "./docs/snippets/import-module.ps1" 51 | ``` 52 | 53 | === ":fontawesome-brands-linux:   Linux" 54 | 55 | Prerequisite for module install on Linux Machine 56 | 57 | ```bash 58 | --8<-- "./docs/snippets/pre-req-linux.sh" 59 | ``` 60 | 61 | From a system with an Internet connection, save the module dependencies from the PowerShell Gallery by running the following commands in the PowerShell console: 62 | 63 | ```powershell 64 | --8<-- "./docs/snippets/save-module-local-linux.ps1" 65 | ``` 66 | 67 | From the system with an Internet connection, copy the module dependencies to a target system by running the following commands in the PowerShell console: 68 | 69 | ```bash 70 | --8<-- "./docs/snippets/copy-module-local-linux.sh" 71 | ``` 72 | 73 | On the target system, import the module dependencies by running the following commands in the PowerShell console: 74 | 75 | ```powershell 76 | --8<-- "./docs/snippets/import-module-local-linux.ps1" 77 | ``` 78 | 79 | :material-information-slab-circle:   [Reference](./documentation/functions/Test-VcfPasswordManagementPrereq.md) 80 | 81 | Once installed, any cmdlets associated with `VMware.CloudFoundation.PasswordManagement` and the its dependencies will be available for use. 82 | 83 | To view the cmdlets for available in the module, run the following command in the PowerShell console. 84 | 85 | ```powershell 86 | Get-Command -Module VMware.CloudFoundation.PasswordManagement 87 | ``` 88 | 89 | To view the help for any cmdlet, run the `Get-Help` command in the PowerShell console. 90 | 91 | For example: 92 | 93 | ```powershell 94 | Get-Help -Name Invoke-PasswordPolicyManager 95 | ``` 96 | 97 | ```powershell 98 | Get-Help -Name Invoke-PasswordPolicyManager -Examples 99 | ``` 100 | 101 | ```powershell 102 | Get-Help -Name Invoke-PasswordPolicyManager -Full 103 | ``` 104 | -------------------------------------------------------------------------------- /docs/license.md: -------------------------------------------------------------------------------- 1 | --8<-- "./LICENSE" 2 | -------------------------------------------------------------------------------- /docs/release-notes.md: -------------------------------------------------------------------------------- 1 | --8<-- "./CHANGELOG.md" 2 | -------------------------------------------------------------------------------- /docs/requirements.txt: -------------------------------------------------------------------------------- 1 | mkdocs-git-revision-date-localized-plugin>=1.2.2 2 | mkdocs-markdownextradata-plugin>=0.2.5 3 | mkdocs-minify-plugin>=0.7.2 4 | mkdocs-open-in-new-tab>=1.0.3 5 | -------------------------------------------------------------------------------- /docs/snippets/aria-parameters.md: -------------------------------------------------------------------------------- 1 | Products that are supported: 2 | 3 | | Parameter | Product | 4 | | -------- | ------------------------------------| 5 | | `vrslcm` | VMware Aria Suite Lifecycle | 6 | | `vrops` | VMware Aria Operations | 7 | | `vrli` | VMware Aria Operations for Logs | 8 | | `vrni` | VMware Aria Operations for Networks | 9 | | `vra` | VMware Aria Automation | 10 | -------------------------------------------------------------------------------- /docs/snippets/copy-module-local-linux.sh: -------------------------------------------------------------------------------- 1 | scp -r /home/modules/* username@remote_host:/home/lab/.local/share/powershell/Modules/ -------------------------------------------------------------------------------- /docs/snippets/copy-module-local-windows.ps1: -------------------------------------------------------------------------------- 1 | Copy-Item -Path F:\Modules\* -Destination '\\\C$\Program Files\WindowsPowerShell\Modules\' -Recurse 2 | -------------------------------------------------------------------------------- /docs/snippets/import-module-local-linux.ps1: -------------------------------------------------------------------------------- 1 | Import-Module -Name VMware.PowerCLI 2 | Import-Module -Name VMware.vSphere.SsoAdmin 3 | Import-Module -Name PowerVCF 4 | Import-Module -Name PowerValidatedSolutions 5 | Import-Module -Name VMware.CloudFoundation.PasswordManagement 6 | -------------------------------------------------------------------------------- /docs/snippets/import-module-tests.ps1: -------------------------------------------------------------------------------- 1 | Import-Module -Name VMware.PowerCLI 2 | Import-Module -Name VMware.vSphere.SsoAdmin 3 | Import-Module -Name PowerVCF 4 | Import-Module -Name PowerValidatedSolutions 5 | Import-Module ./VMware.CloudFoundation.PasswordManagement.psd1 6 | -------------------------------------------------------------------------------- /docs/snippets/import-module.ps1: -------------------------------------------------------------------------------- 1 | Import-Module -Name VMware.PowerCLI 2 | Import-Module -Name VMware.vSphere.SsoAdmin 3 | Import-Module -Name PowerVCF 4 | Import-Module -Name PowerValidatedSolutions 5 | Import-Module -Name VMware.CloudFoundation.PasswordManagement 6 | -------------------------------------------------------------------------------- /docs/snippets/install-module.ps1: -------------------------------------------------------------------------------- 1 | Set-PSRepository -Name PSGallery -InstallationPolicy Trusted 2 | Install-Module -Name VMware.PowerCLI -MinimumVersion 13.3.0 -Scope AllUsers 3 | Install-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9 -Scope AllUsers 4 | Install-Module -Name PowerVCF -MinimumVersion 2.4.1 -Scope AllUsers 5 | Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.11.1 -Scope AllUsers 6 | Install-Module -Name VMware.CloudFoundation.PasswordManagement -Scope AllUsers 7 | -------------------------------------------------------------------------------- /docs/snippets/installed-module.ps1: -------------------------------------------------------------------------------- 1 | Get-InstalledModule -Name VMware.CloudFoundation.PasswordManagement 2 | -------------------------------------------------------------------------------- /docs/snippets/pre-req-linux.sh: -------------------------------------------------------------------------------- 1 | mkdir /home/modules -------------------------------------------------------------------------------- /docs/snippets/save-module-local-linux.ps1: -------------------------------------------------------------------------------- 1 | Save-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9 -Path /home/modules 2 | Save-Module -Name VMware.PowerCLI -MinimumVersion 13.3.0 -Path /home/modules 3 | Save-Module -Name PowerVCF -MinimumVersion 2.4.1 -Path /home/modules 4 | Save-Module -Name PowerValidatedSolutions -MinimumVersion 2.12.1 -Path /home/modules 5 | Save-Module -Name VMware.CloudFoundation.PasswordManagement -Path /home/modules 6 | -------------------------------------------------------------------------------- /docs/snippets/save-module-local-windows.ps1: -------------------------------------------------------------------------------- 1 | Save-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9 -Path F:\Modules\ 2 | Save-Module -Name VMware.PowerCLI -MinimumVersion 13.3.0 -Path F:\Modules 3 | Save-Module -Name PowerVCF -MinimumVersion 2.4.1 -Path F:\Modules\ 4 | Save-Module -Name PowerValidatedSolutions -MinimumVersion 2.12.1 -Path F:\Modules\ 5 | Save-Module -Name VMware.CloudFoundation.PasswordManagement -Path F:\Modules\ 6 | -------------------------------------------------------------------------------- /docs/snippets/update-module.ps1: -------------------------------------------------------------------------------- 1 | Update-Module -Name VMware.CloudFoundation.PasswordManagement 2 | -------------------------------------------------------------------------------- /docs/snippets/update-modules.ps1: -------------------------------------------------------------------------------- 1 | Update-Module -Name VMware.PowerCLI 2 | Update-Module -Name VMware.vSphere.SsoAdmin 3 | Update-Module -Name PowerVCF 4 | Update-Module -Name PowerValidatedSolutions 5 | -------------------------------------------------------------------------------- /docs/update.md: -------------------------------------------------------------------------------- 1 | # Updating the Module 2 | 3 | Update the PowerShell module from the PowerShell Gallery by running the following commands: 4 | 5 | ```powershell 6 | --8<-- "./docs/snippets/update-module.ps1" 7 | ``` 8 | 9 | To verify that the PowerShell module is updated, run the following command in the PowerShell console. 10 | 11 | ```powershell 12 | --8<-- "./docs/snippets/installed-module.ps1" 13 | ``` 14 | 15 | If a dependency does not meet the minimum requirements, run the appropriate `Update-Module` command for the dependency in the PowerShell console. 16 | 17 | ```powershell 18 | --8<-- "./docs/snippets/update-modules.ps1" 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/user-access.md: -------------------------------------------------------------------------------- 1 | # User Access 2 | 3 | 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. 4 | 5 | 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. 6 | 7 | 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., `administrator@vsphere.local`). 8 | -------------------------------------------------------------------------------- /tests/inputData.json.example: -------------------------------------------------------------------------------- 1 | { 2 | "SDDC Manager": "vcf01-m01-sm01.example.com", 3 | "SDDC Manager VM Name": "sm01", 4 | "User": "administrator@vsphere.local", 5 | "Password": "VMw@re1!", 6 | "Root User": "root", 7 | "Root Password": "VMw@re1!", 8 | "Guest User": "root", 9 | "Local User": "vcf", 10 | "SSO Admin": "admin@local", 11 | "SSO Password": "VMw@re1!VMw@re1!", 12 | "Domains": [ 13 | "vcf01-m01", 14 | "vcf01-w01" 15 | ], 16 | "vcf01-m01": { 17 | "Aria" : { 18 | "Aria Suite Lifecycle": "vcf01-m01-lcm01.example.com", 19 | "Aria Operations": "vcf01-m01-ops01a.example.com", 20 | "Aria Operations Logs": "vcf01-m01-logs01a.example.com", 21 | "Aria Automation": "vcf01-m01-auto01a.example.com", 22 | "Workspace ONE Access": "vcf01-m01-wsa01a.example.com" 23 | }, 24 | "ESX Hosts": [ 25 | "vcf01-m01-esx01.example.com", 26 | "vcf01-m01-esx02.example.com", 27 | "vcf01-m01-esx03.example.com", 28 | "vcf01-m01-esx04.example.com" 29 | ], 30 | "Clusters": [ 31 | "vcf01-m01-cl01" 32 | ], 33 | "NSX Manager": [ 34 | "vcf01-m01-nsx01.example.com" 35 | ], 36 | "NSX Manager Nodes": [ 37 | "vcf01-m01-nsx01a.example.com", 38 | "vcf01-m01-nsx01b.example.com", 39 | "vcf01-m01-nsx01c.example.com" 40 | ], 41 | "NSX Edge Nodes": [ 42 | "vcf01-m01-en01", 43 | "vcf01-m01-en02" 44 | ], 45 | "NSX Edge FQDN": [ 46 | "vcf01-m01-en01.example.com", 47 | "vcf01-m01-en02.example.com" 48 | ], 49 | "vCenter": [ 50 | "vcf01-m01-vc01.example.com" 51 | ] 52 | }, 53 | "vcf01-w01": { 54 | "ESX Hosts": [ 55 | "vcf01-w01-esx01.example.com", 56 | "vcf01-w01-esx02.example.com", 57 | "vcf01-w01-esx03.example.com", 58 | "vcf01-w01-esx04.example.com" 59 | ], 60 | "Clusters": [ 61 | "vcf01-w01-cl01" 62 | ], 63 | "NSX Manager": [ 64 | "vcf01-w01-nsx01.example.com" 65 | ], 66 | "NSX Manager Nodes": [ 67 | "vcf01-w01-nsx01a.example.com", 68 | "vcf01-w01-nsx01b.example.com", 69 | "vcf01-w01-nsx01c.example.com" 70 | ], 71 | "NSX Edge Nodes": [ 72 | "vcf01-w01-en01", 73 | "vcf01-w01-en02" 74 | ], 75 | "NSX Edge FQDN": [ 76 | "vcf01-w01-en01.example.com", 77 | "vcf01-w01-en02.example.com" 78 | ], 79 | "vCenter": [ 80 | "vcf01-w01-vc01.example.com" 81 | ] 82 | } 83 | } 84 | -------------------------------------------------------------------------------- /tests/logs/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vmware/powershell-module-for-vmware-cloud-foundation-password-management/71f1331758d40cdff7de7078c68d539820017ad0/tests/logs/.gitkeep --------------------------------------------------------------------------------