Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimurrito/ionmod
A simple and fast powershell module to handle API requests to Ionos's Domain Management API.
https://github.com/jimurrito/ionmod
automation dns dns-updater ionos powershell powershell-module
Last synced: about 1 month ago
JSON representation
A simple and fast powershell module to handle API requests to Ionos's Domain Management API.
- Host: GitHub
- URL: https://github.com/jimurrito/ionmod
- Owner: jimurrito
- License: gpl-3.0
- Created: 2024-03-29T17:42:05.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-06-20T23:35:01.000Z (6 months ago)
- Last Synced: 2024-06-22T10:10:21.853Z (6 months ago)
- Topics: automation, dns, dns-updater, ionos, powershell, powershell-module
- Language: PowerShell
- Homepage:
- Size: 2.67 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# IonMod : **[Unofficial]** Powershell/C# SDK for IONOS Domains
A simple and fast SDK for managing IONOS domains and records. This an unofficial project, and is not maintained by IONOS.
This library is for C# and Powershell use.
> **Warning!**
> The change to C# was breaking. Please see below examples on the login change.
# Getting started
- [**PowerShell Gallery/Nuget**](https://www.powershellgallery.com/packages/IonMod)
- `install-module IonMod`
- **Git**
- `git clone https://github.com/jimurrito/IonMod`
- `import-module path/to/IonMod.psd1`
# Example
Simple set of cmdlets to get all DNS Zones accessible by the API credentials provided.
```Powershell
Import-Module IonMod
Connect-Ion -PublicPrefix "XXXX" -Secret "XXXX"
Get-IonZone
Records Name Id Type
------- ---- -- ----
contoso.com 00000000-0000-0000-0000-000000000000 NATIVE
favicon.com 00000000-0000-0000-0000-000000000000 NATIVE
whatdoesthefedsay.com 00000000-0000-0000-0000-000000000000 NATIVE
```
# Documentation
- [**Powershell Cmdlets**](/IonMod/Cmdlets/PSCmd.md)
- [**C# Library**](/IonMod/Cmdlets/CSCmd.md)
# Known issue with `using` keyword when using `IonMod.psd1` from source in Powershell.
[As mentioned here](https://github.com/jimurrito/PSTest?tab=readme-ov-file#how-to-use-pstest), the `using` keyword will not work with the named module when importing the module from source. Rule of thumb is that if you are using `Import-Module` and the module manifest file `.psd1`, you will also need to use the path when declaring `using` in Powershell.
```Powershell
# Choose one!
# From Nuget
Install-Module IonMod
Import-Module IonMod
using module IonMod
# From Source
git <....>
Import-Module /path/to/IonMod.psd1
using module /path/to/IonMod.psd1
```
This is not an issue in C#, and is purely a limitation of how Powershell's `using` keyword queries the available modules.
## Any issues?
Please open an issue on this repo!