{"id":18811733,"url":"https://github.com/logicmonitor/lm-powershell-module","last_synced_at":"2025-04-13T20:31:40.602Z","repository":{"id":234069944,"uuid":"787490674","full_name":"logicmonitor/lm-powershell-module","owner":"logicmonitor","description":"PowerShell module for accessing the LogicMonitor REST API.","archived":false,"fork":false,"pushed_at":"2024-10-16T20:41:56.000Z","size":741,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-19T19:16:22.383Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/logicmonitor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-16T16:11:40.000Z","updated_at":"2024-10-16T20:40:41.000Z","dependencies_parsed_at":"2024-06-22T11:56:22.350Z","dependency_job_id":"2b89839d-5d36-4435-b2d0-2b8b1c960239","html_url":"https://github.com/logicmonitor/lm-powershell-module","commit_stats":null,"previous_names":["logicmonitor/lm-powershell-module"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logicmonitor%2Flm-powershell-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logicmonitor%2Flm-powershell-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logicmonitor%2Flm-powershell-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/logicmonitor%2Flm-powershell-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/logicmonitor","download_url":"https://codeload.github.com/logicmonitor/lm-powershell-module/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223604530,"owners_count":17172314,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T23:27:28.085Z","updated_at":"2025-04-13T20:31:40.572Z","avatar_url":"https://github.com/logicmonitor.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build PSGallery Release](https://github.com/logicmonitor/lm-powershell-module/actions/workflows/main.yml/badge.svg?event=release)](https://github.com/logicmonitor/lm-powershell-module/actions/workflows/main.yml)\\\n[![Test Current Build on PowerShell Core 7.4.1](https://github.com/logicmonitor/lm-powershell-module/actions/workflows/test.yml/badge.svg)](https://github.com/logicmonitor/lm-powershell-module/actions/workflows/test.yml)\\\n[![Test Current Build on Windows Powershell 5.1](https://github.com/logicmonitor/lm-powershell-module/actions/workflows/test-win.yml/badge.svg)](https://github.com/logicmonitor/lm-powershell-module/actions/workflows/test-win.yml)\n\n# General\n\nPowerShell module for accessing the LogicMonitor REST API.\n\nThis project is also published in the PowerShell Gallery at https://www.powershellgallery.com/packages/Logic.Monitor/.\n\nCheck out the full Logic.Monitor module documenation at: [https://logicmonitor.github.io/lm-powershell-module-docs/](https://logicmonitor.github.io/lm-powershell-module-docs/)\n\n\n**Community Contribution Notice**: This PowerShell module is an open-source project created and maintained by LogicMonitor users. While not an official LogicMonitor product, it's designed by people who use and understand the platform.\n\nThe module is freely available for everyone to use, modify, and improve. We welcome your feedback and contributions! If you have ideas or encounter any issues, please share them through GitHub issues or pull requests.\n\nMany community members rely on this module in their daily operations. Though we can't offer formal support guarantees, our collaborative community strives to address questions and continuously enhance functionality.\n\nWe hope you find this tool valuable for your LogicMonitor workflows!\n\n# Installation\n\n- From PowerShell Gallery:\n\n```powershell\nInstall-Module -Name \"Logic.Monitor\"\n```\n\n# Upgrading\n\n- New releases are published often, to ensure you have the latest version you can run:\n\n```powershell\nUpdate-Module -Name \"Logic.Monitor\"\n```\n\n# General Usage\n\nBefore you can use on module commands you will need to be connected to a LM portal. To connect your LM portal use the **Connect-LMAccount** command:\n\n```powershell\nConnect-LMAccount -AccessId \"lm_access_id\" -AccessKey \"lm_access_key\" -AccountName \"lm_portal_prefix_name\"\n```\n\nOnce connected you can then run an appropriate command, a full list of commands available can be found using:\n\n```powershell\nGet-Command -Module \"Logic.Monitor\"\n```\n\nTo disconnect from an account simply run the Disconnect-LMAccount command:\n\n```powershell\nDisconnect-LMAccount\n```\n\nTo cache credentials for multiple portals you can use the command New-LMCachedAccount, once a credential has been cached you can reference it when connecting to an lm portal using the -UserCachedCredentials switch in Connect-LMAccount.\n\nCached credentials are stored in a LocalVault using **Microsoft's SecretManagement** module. If its your first time using SecretManagement you will be prompted to set up a password for accessing your cached accounts in the LocalVault using this method.\n\n```powershell\nNew-LMCachedAccount -AccessId \"lm_access_id\" -AccessKey \"lm_access_key\" -AccountName \"lm_portal_prefix_name\"\nConnect-LMAccount -UseCachedCredential\n\n#Example output when using cached credentials\n#Selection Number | Portal Name\n#0) portalname\n#1) portalnamesandbox\n#Enter the number for the cached credential you wish to use: 1\n#Connected to LM portal portalnamesandbox using account\n```\n\n# Change List\n\n## 7.0.1\n### Restore 5.1 compatibility\nIt was brought to our attention that version 7.0 broke backwards compatibility with older versions of PowerShell. It was not our intention to remove compatibility with this latest update. The dependencies that required 7+ have been replaced with native PWSH commands and compatibility with 5.1 has been restored.\n### Updated Cmdlets:\n - **Get-LMDeviceDatasourceInstanceGroup**: Added *-InstanceGroupName* to the available parameters to allow for easy filtering for a specific instance group.\n - **Remove-LMDeviceDatasourceInstanceGroup**: Added *-InstanceGroupName* and *-HdsId* to the available parameters to allow for easy targeting for a specific instance group.\n\n## Previous Release 7.0\n\n### Documentation Overhaul\nWe're excited to announce our new comprehensive documentation site at [https://logicmonitor.github.io/lm-powershell-module-docs/](https://logicmonitor.github.io/lm-powershell-module-docs/). The site includes:\n- Detailed command reference information\n- Code examples and snippets\n- Best practices guides\n\n### New Filter Wizard\nIntroducing the Filter Wizard, a new interactive tool to help build complex filters:\n- Visual filter construction\n- Support for all filter operators\n- Real-time filter preview\n- Available through `Build-LMFilter` or `-FilterWizard` parameter\n\n```powershell\n# Use the standalone filter builder\nBuild-LMFilter\n\n# Use built-in filter wizard parameter\nGet-LMDeviceGroup -FilterWizard\n```\n![Filter Wizard Example](https://logicmonitor.github.io/lm-powershell-module-docs/_astro/LMFilter.4g625cq9_1boMAv.webp)\n\n\n[Previous Release Notes](RELEASENOTES.md)\n\n# License\nCopyright, 2024, LogicMonitor, Inc.\n\nThis Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flogicmonitor%2Flm-powershell-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flogicmonitor%2Flm-powershell-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flogicmonitor%2Flm-powershell-module/lists"}