├── .github └── FUNDING.yml ├── .gitignore ├── LICENSE ├── NC-ClassMethods.txt ├── NC-Commands.txt ├── PS-NCentral.psd1 ├── PS-NCentral.psm1 ├── PS-NCentral_Connection_Class.png ├── PS-NCentral_Examples.ps1 ├── PS-NCentral_Manifest.ps1 ├── PS-NCentral_Structure.png └── README.md /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [ToschAutomatisering] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 13 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 14 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | .vscode/launch.json 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /NC-ClassMethods.txt: -------------------------------------------------------------------------------- 1 | Methods included in the NCentral_Connection Class. 2 | 3 | Name MemberType 4 | ---- ---------- 5 | AccessGroupGet Method 6 | AccessGroupList Method 7 | ActiveIssuesList Method 8 | Connect Method 9 | ConvertBase64 Method 10 | CustomerAdd Method 11 | CustomerList Method 12 | CustomerListChildren Method 13 | CustomerModify Method 14 | CustomerPropertyValue Method 15 | DeviceAssetInfoExportDevice Method 16 | DeviceAssetInfoExportDeviceWithSettings Method 17 | DeviceGet Method 18 | DeviceGetAppliance Method 19 | DeviceGetStatus Method 20 | DeviceList Method 21 | DevicePropertyID Method 22 | DevicePropertyList Method 23 | DevicePropertyModify Method 24 | ErrorHandler Method 25 | FixDates Method 26 | FixProperties Method 27 | IsEncodedBase64 Method 28 | JobStatusList Method 29 | OrganizationPropertyID Method 30 | OrganizationPropertyList Method 31 | OrganizationPropertyModify Method 32 | UserAdd Method 33 | UserRoleGet Method 34 | UserRoleList Method 35 | 36 | -------------------------------------------------------------------------------- /NC-Commands.txt: -------------------------------------------------------------------------------- 1 | Type NCHelp or Get-NCHelp for the list of available PS-NCentral commands. 2 | Use 'Get-Help ' for additional help. 3 | 4 | Name Synopsis 5 | ---- -------- 6 | Add-NCCustomerPropertyValue The Value is added to the comma-separated string of unique values in the Customer Property. 7 | Add-NCDevicePropertyValue The Value is added to the comma-separated string of unique values in the Custom Device Property. 8 | Backup-NCCustomProperties Backup CustomProperties to a file. Customer or Device. WIP 9 | Convert-Base64 Encode or Decode a string to or from Base64. 10 | Format-Properties Unifies the properties for all Objects in a list. 11 | Get-NCAccessGroupDetails Returns the details of the specified (CustomerAccess) GroupID. 12 | Get-NCAccessGroupList Returns the list of AccessGroups at the specified CustomerID level. 13 | Get-NCActiveIssuesList Returns the Active Issues on the CustomerID-level and below. 14 | Get-NCCustomerList Returns a list of all customers and their data. ChildrenOnly when CustomerID is specified. 15 | Get-NCCustomerProperty Retrieve the Value of the specified property(name) for the Customer(ID). Base64 optional. 16 | Get-NCCustomerPropertyList Returns a list of all (Custom-)Properties for the selected CustomerID(s). 17 | Get-NCDeviceID Returns the DeviceID(s) for the given DeviceName(s). Case Sensitive, No Wildcards. 18 | Get-NCDeviceInfo Returns the General details for the DeviceID(s). 19 | Get-NCDeviceList Returns the Managed Devices for the given CustomerID(s) and Sites below. 20 | Get-NCDeviceLocal Returns the DeviceID, CustomerID and some more Info for the Local Computer. 21 | Get-NCDeviceObject Returns a Device and the asset-properties as an object. 22 | Get-NCDeviceProperty Returns the Value of the Custom Device Property. Base64 optional. 23 | Get-NCDevicePropertyList Returns the Custom Properties of the DeviceID(s). 24 | Get-NCDevicePropertyListFi… Returns the Custom Properties of the Devices within the FilterID(s). 25 | Get-NCDeviceStatus Returns the Services for the DeviceID(s). 26 | Get-NCHelp Shows a list of available PS-NCentral commands and the synopsis. 27 | Get-NCJobStatusList Returns the Scheduled Jobs on the CustomerID-level and below. 28 | Get-NCProbeList Returns the Probes for the given CustomerID(s). 29 | Get-NCServiceOrganizationL… Returns a list of all ServiceOrganizations and their data. 30 | Get-NCTimeOut Returns the max. time in seconds to wait for data returning from a (Synchronous) NCentral API-r… 31 | Get-NCUserRoleDetails Returns the Details of the specified RoleID. 32 | Get-NCUserRoleList Returns the list of Roles at the specified CustomerID level. 33 | Get-NCVersion Returns the N-Central Version(s) of the connected server. 34 | NcConnected Checks or initiates the NCentral connection. 35 | New-NCentralConnection Connect to the NCentral server. 36 | Remove-NCCustomerPropertyV… The Value is removed from the comma-separated string of unique values in the Customer Property. 37 | Remove-NCDevicePropertyVal… The Value is removed from the comma-separated string of unique values in the Custom Device Prop… 38 | Select-NCCustomerUI Returns a CustomerID from an interactive Selection-UI. 39 | Select-NCDeviceUI Returns a DeviceID from an interactive Selection-UI for a given CustomerID. 40 | Set-NCCustomerDefault Sets the DefaultCustomerID to be used. 41 | Set-NCCustomerProperty Fills the specified property(name) for the given CustomerID(s). Base64 optional. 42 | Set-NCDeviceProperty Set the value of the Custom Property for the DeviceID(s). Base64 optional. 43 | Set-NCTimeOut Sets the max. time in seconds to wait for data returning from a (Synchronous) NCentral API-requ… 44 | 45 | 46 | StatusCode Description 47 | ---------- ----------- 48 | 1 No Data 49 | 2 Stale 50 | 3 Normal 51 | 4 Warning 52 | 5 Failed 53 | 6 Misconfigured 54 | 7 Disconnected 55 | 8 Disabled 56 | 11 Unacknowledged 57 | 12 Acknowledged 58 | 59 | -------------------------------------------------------------------------------- /PS-NCentral.psd1: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ToschAutomatisering/PS-NCentral/5281cde421da2f388a23930034240dc303b8077b/PS-NCentral.psd1 -------------------------------------------------------------------------------- /PS-NCentral.psm1: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ToschAutomatisering/PS-NCentral/5281cde421da2f388a23930034240dc303b8077b/PS-NCentral.psm1 -------------------------------------------------------------------------------- /PS-NCentral_Connection_Class.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ToschAutomatisering/PS-NCentral/5281cde421da2f388a23930034240dc303b8077b/PS-NCentral_Connection_Class.png -------------------------------------------------------------------------------- /PS-NCentral_Examples.ps1: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ToschAutomatisering/PS-NCentral/5281cde421da2f388a23930034240dc303b8077b/PS-NCentral_Examples.ps1 -------------------------------------------------------------------------------- /PS-NCentral_Manifest.ps1: -------------------------------------------------------------------------------- 1 | ## Script to generate the manifest (.psd1) for the module. 2 | 3 | ## Make sure only the .psm1 (v0.0) is imported 4 | $FunctionsToExport = (Get-Module PS-NCentral).ExportedCommands.Values.Name 5 | 6 | $Parms = @{ 7 | RootModule = "PS-NCentral.psm1" 8 | Description = "PowerShell integration for N-Central(c) by N-Able(R)" 9 | Path = ("{0}\PS-NCentral.psd1" -f $PSScriptRoot ) 10 | Author = "Adriaan Sluis" 11 | CompanyName = "Tosch Automatisering" 12 | Copyright = "(c) 2022 Tosch Automatisering BV. All rights reserved." 13 | ModuleVersion = "1.6" 14 | FunctionsToExport = $FunctionsToExport 15 | LicenseUri = 'https://github.com/ToschAutomatisering/PS-NCentral/blob/master/LICENSE' 16 | ProjectUri = 'https://github.com/ToschAutomatisering/PS-NCentral' 17 | Tags = 'PS-NCentral','N-Central','N-Able' 18 | } 19 | 20 | New-ModuleManifest @Parms 21 | #Update-ModuleManifest @Parms 22 | 23 | 24 | Test-ModuleManifest $Parms.path | Format-List 25 | 26 | -------------------------------------------------------------------------------- /PS-NCentral_Structure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ToschAutomatisering/PS-NCentral/5281cde421da2f388a23930034240dc303b8077b/PS-NCentral_Structure.png -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PS-NCentral 2 | ## PowerShell integration for N-Central (c) by N-Able (R) 3 | 4 | Integrate NCentral into your management-scripts with this module. 5 | 6 | Type NCHelp or Get-NCHelp after loading the module to see all available commands. 7 | 8 | This module is also available on PowerShellGallery: 9 | https://www.powershellgallery.com/packages/PS-NCentral 10 | 11 | Additional documentation can be found at: 12 | https://github.com/AngryProgrammerInside/NC-API-Documentation 13 | --------------------------------------------------------------------------------