topic Re: Meraki PowerShell Module - All Endpoints in Network Platform API

Meraki PowerShell Module - All Endpoints

DocNougat — Thu, 02 Nov 2023 15:54:59 GMT

Hi Everyone,

I got a little frustrated by the lack of any official PowerShell module for Cisco's Meraki products and the existing independently developed modules only have a fraction of the available endpoints. So to remedy this issue I wrote my own. I've been working on it on and off for a few months and I've finally reached a point that I'm considering the 1.0 release. There are 644 commands in total and I've been able to test a majority of the Get commands. The others I've had less opportunity to verify, but I have tested and used a few of them in production ready scripts. I'm still working on more detailed documentation, but in its current form it's ready for other humans to start playing with it and providing feedback.

I've published it to GitHub and the official PowerShell Gallery repository so you can install manually or simply by running the install command from an elevated PowerShell window:

Install-Module Meraki

You'll need an API key from your Meraki dashboard to get started.

Check the GitHub page for more information and usage examples:
Meraki PowerShell Module on GitHub

If anyone from Cisco is watching this thread, please send me free gear to validate my module with.

I'm already using this heavily in my own environment, but I'm looking for more people to test and provide feedback.

P.S. I'm #notTheNetworkGuy, I'm an IT Operations engineer and my job is largely focused on automating our environment. Nothing I've done here couldn't also have been easily accomplished with the existing Python library, but everything else in my mostly Windows-centric world is using PowerShell, so I made this to be able to write everything in the same language.

Re: Meraki PowerShell Module - All Endpoints

aleabrahao — Thu, 02 Nov 2023 17:01:01 GMT

Maybe it will help you.

https://www.powershellgallery.com/packages?q=Tags%3A%22Meraki%22

Re: Meraki PowerShell Module - All Endpoints

DocNougat — Thu, 02 Nov 2023 17:16:10 GMT

It was actually the existing lackluster options that caused me to create this.

Re: Meraki PowerShell Module - All Endpoints

Philip D'Ath — Thu, 02 Nov 2023 18:16:41 GMT

Well done. What a great effort.

Re: Meraki PowerShell Module - All Endpoints

DocNougat — Thu, 02 Nov 2023 18:19:41 GMT

Thanks!

Re: Meraki PowerShell Module - All Endpoints

Brash — Thu, 02 Nov 2023 22:10:53 GMT

Good to see (and welcome to the community)!
Thanks for putting in the effort, it looks great.

The lack of a decent powershell module was something I noticed early on too but I'm nowhere near proficient enough to write my own.

Re: Meraki PowerShell Module - All Endpoints

DarkStar1 — Tue, 16 Jan 2024 21:11:46 GMT

@DocNougat I add this module and it looks extremely promising. I need to update a SSID across 170 networks and have been playing with the following commands but I keep getting error messages. I think there is a bug in the code or there is just not enough information to write the commands correctly on my part. Any help you can provide would be greatly appreciated.

$SSIDConfig = {"name":"TEST- Vendor 2" "enabled":"True" "authMode":"psk" "psk":"TestTest1" "encryptionMode":"wpa" "wpaEncryptionMode":"WPA3 Transition Mode" "ipAssignmentMode":"NAT Mode" "bandSelection":"Dual band operation" "lanIsolationEnabled":"False"}

$SSIDConfig = $SSIDConfig | ConvertTo-Json -Compress

Set-MerakiNetworkWirelessSSID -AuthToken "7xxxxxxxxxxxxxxxxxxxxxxx" -NetworkId "L_6xxxxxxxxxxxxxxxxxxx" -Number 2 -SSIDConfig $SSIDConfig

The first issue is that it does not like the {"name":"Test - Vendor 2" .... I have tired comas, spaces, semi-colons, as well as single quotes and double quotes, etc.

I have also tried @{"name":"TEST- Vendor 2" .....} in case it thinks it is an ARRAY. So far I cannot get past this.

Error:

At line:1 char:18
+ $SSIDConfig = {"name":"TEST - Vendor 2","enabled":"True","authMo ...
+ ~~~
Unexpected token ':"TEST - Vendor 2"' in expression or statement.

I tried the following which does not give me an error for the $SSIDConfig but does give me a message when I use the Set-MerakiNetworkWirelessSSID command.

$SSIDConfig = {name:TEST - Vendor 2,enabled:True,authMode:psk,psk:TestTest1,encryptionMode:wpa,wpaEncryptionMode:WPA3 Transition Mode,ipAssignmentMode:NAT Mode,bandSelection:Dual band operation,lanIsolationEnabled:False}

$SSIDConfig = $SSIDConfig | ConvertTo-Json -Compress

Set-MerakiNetworkWirelessSSID -AuthToken "7xxxxxxxxxxxxxxxxxxxxxxx" -NetworkId "L_6xxxxxxxxxxxxxxxxxxx" -Number 2 -SSIDConfig $SSIDConfig

Error:

The remote server returned an error: (400) Bad Request.

Any suggestions or help would be most helpful. Thanks.

Re: Meraki PowerShell Module - All Endpoints

Philip D'Ath — Tue, 16 Jan 2024 21:27:43 GMT

What happens if you use a name of "Test" (an invalid SSID - does that resolve the "Unexpected token" error?).

Re: Meraki PowerShell Module - All Endpoints

DarkStar1 — Wed, 17 Jan 2024 17:23:38 GMT

Thanks for the idea, however same Error:

$SSIDConfig = {"name":"Test","enabled":"True","authMode":"psk","psk":"TestTest1","encryptionMode":"wpa","wpaEncryptionMode":"WPA3 Transition Mode","ipAssignmentMode":"NAT Mode","bandSelection":"Dual band operation","lanIsolationEnabled":"False"}
At line:1 char:23
+ $SSIDConfig = {"name":"Test","enabled":"True","authMode":"psk","psk" ...
+ ~~~~~~~
Unexpected token ':"Test"' in expression or statement.
At line:1 char:30
+ $SSIDConfig = {"name":"Test","enabled":"True","authMode":"psk","psk" ...
+ ~
Missing argument in parameter list.
+ CategoryInfo : ParserError: (:) [], ParentContainsErrorRecordException
+ FullyQualifiedErrorId : UnexpectedToken

Re: Meraki PowerShell Module - All Endpoints

aleabrahao — Wed, 17 Jan 2024 17:27:31 GMT

The syntax is incorrect. In PowerShell, hashtables are defined using @{} and key-value pairs are separated by = and semicolons ;

Re: Meraki PowerShell Module - All Endpoints

DarkStar1 — Wed, 17 Jan 2024 18:44:07 GMT

Thanks. I think I tried that and then you get prompted for more information from PS.

Yup tested it just now and I get the PS >> prompt requesting more information.

$SSIDConfig = @{"name":"Test";"enabled":"True";"authMode":"psk";"psk":"TestTest1";"encryptionMode":"wpa";"wpaEncryptionMode":"WPA3 Transition Mode";"ipAssignmentMode":"NAT Mode";"bandSelection":"Dual band operation";"lanIsolationEnabled":"False"}
>>

Re: Meraki PowerShell Module - All Endpoints

DarkStar1 — Wed, 17 Jan 2024 18:47:56 GMT

Opps forgot the = ... did that and it works but you get the error from PS

The remote server returned an error: (400) Bad Request.

Re: Meraki PowerShell Module - All Endpoints

aleabrahao — Wed, 17 Jan 2024 18:51:31 GMT

Sorry for the question, but what exactly are you trying to update? Are these networks in a template?

Re: Meraki PowerShell Module - All Endpoints

DarkStar1 — Wed, 17 Jan 2024 18:53:41 GMT

I think the problem is that as a hashtable it is not in JSON format.

Here is what is stored for the variable but that is not the right format.

PS > $SSIDConfig
{"enabled":"True","ipAssignmentMode":"NAT Mode","encryptionMode":"wpa","wpaEncryptionMode":"WPA3 Transition Mode","name":"Test","authMode":"psk","psk":"TestTest1","lanIsolationEnabled":"False","bandSelection":"Dual band operation"}

Should look something like this:

{"Attributes":[],"File":null,"IsFilter":false,"IsConfiguration":false,"Module":null,"StartPosition":{"Content":"{name:Test,enabled:True,authMode:psk,psk:TestTest1,encryptionMode:wpa,wpaEncryptionMode:WPA3 Transition Mode,ipAssignmentMode:NAT Mode,bandSelection:Dual band operation,lanIsolationEnabled:False}","Type":19,"Start":14,"Length":205,"StartLine":1,"StartColumn":15,"EndLine":1,"EndColumn":220},"DebuggerHidden":false,"Id":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","Ast":{"Attributes":[],"UsingStatements":[],"ParamBlock":null,"BeginBlock":null,"ProcessBlock":null,"EndBlock":{"Unnamed":true,"BlockKind":130,"Statements":"name:Test,enabled:True,authMthMode:psk,psk:TestTest1,encryptionMode:wpa,wpaEncryptionMode:WPA3 Transition Mode,ipAssignmentMode:NAT Mode,bandSelection:Dual band operation,lanIsolationEnabled:False","Parent":"{name:Test,enabled:True,authMode:psk,psk:TestTest1,encryptionMode:wpa,wpaEncryptionMode:WPA3 Transition Mode,ipAssignmentMode:NAT Mode,bandSelection:Dual band operation,lanIsolationEnabled:False

Re: Meraki PowerShell Module - All Endpoints

aleabrahao — Wed, 17 Jan 2024 18:56:21 GMT

but what exactly are you trying to update? Details please.

Re: Meraki PowerShell Module - All Endpoints

DocNougat — Wed, 17 Jan 2024 19:39:13 GMT

Hi DarkStar! Thanks for trying out my module. It's still a bit of a work in progress and the thing I'm lacking the most is solid documentation with functional & tested examples. Keep in mind that depending on the device you may need to use Set-MerakiNetworkApplianceSSID instead.
Try using a PSCustomObject and converting it to compressed JSON. It just worked for me:

$SSIDConfig = [PSCustomObject]@{
    name = "Test"
    enabled = $true
    authMode = "psk"
    psk = "TestTest1"
    encryptionMode = "wpa"
    wpaEncryptionMode = "WPA3 Transition Mode"
    ipAssignmentMode = "NAT Mode"
    bandSelection = "Dual band operation"
    lanIsolationEnabled = $false
}

$SSIDConfig = $SSIDConfig | ConvertTo-Json -Compress
Set-MerakiNetworkWirelessSSID -AuthToken $authtoken -NetworkId $NetID -Number 3 -SSIDConfig $SSIDConfig

Re: Meraki PowerShell Module - All Endpoints

DarkStar1 — Wed, 17 Jan 2024 20:07:21 GMT

I assumed the Set-MerakiNetworkApplianceSSID was for the Firewalls that have the WiFi built in?

Re: Meraki PowerShell Module - All Endpoints

DarkStar1 — Wed, 17 Jan 2024 20:08:32 GMT

Tried the above code and I get:

The remote server returned an error: (400) Bad Request.

Re: Meraki PowerShell Module - All Endpoints

DarkStar1 — Wed, 17 Jan 2024 20:16:31 GMT

Here is the whole thing in case you see something wrong (Errors in RED):

PS > $SSIDConfig = [PSCustomObject]@{
>> name = "Test"
>> enabled = "True"
>> authMode = "psk"
>> psk = "TestTest1"
>> encryptionMode = "wpa"
>> wpaEncryptionMode = "WPA3 Transition Mode"
>> ipAssignmentMode = "NAT Mode"
>> bandSelection = "Dual band operation"
>> lanIsolationEnabled = "False"
>> }
PS > $SSIDConfig = $SSIDConfig | ConvertTo-Json -Compress
PS > Set-MerakiNetworkWirelessSSID -AuthToken "7xxxxxxxxxxxxxxxxxxx" -NetworkId "L_xxxxxxxxxxxxxxxxxxxxxx" -Number 2 -SSIDConfig $SSIDConfig
The remote server returned an error: (400) Bad Request.

PS > $SSIDConfig
{"name":"Test","enabled":"True","authMode":"psk","psk":"TestTest1","encryptionMode":"wpa","wpaEncryptionMode":"WPA3 Transition Mode","ipAssignmentMode":"NAT Mode","bandSelection":"Dual band operation","lanIsolationEnabled":"False"}

PS > Set-MerakiNetworkApplianceSSID -AuthToken "7xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -NetworkId "L_^xxxxxxxxxxxxxxxxxxx" -Number 2 -SSIDConfig $SSIDConfig

Set-MerakiNetworkApplianceSSID : A parameter cannot be found that matches parameter name 'Number'.
At line:1 char:120
+ ... xxxxxx" -NetworkId "L_6xxxxxxxxx" -Number 2 -SSID ...
+ ~~~~~~~
+ CategoryInfo : InvalidArgument: (:) [Set-MerakiNetworkApplianceSSID], ParameterBindingException
+ FullyQualifiedErrorId : NamedParameterNotFound,Set-MerakiNetworkApplianceSSID

Re: Meraki PowerShell Module - All Endpoints

DarkStar1 — Wed, 17 Jan 2024 20:19:59 GMT

I am trying to use PowerShell to update 170 Meraki Network SSIDs.