< Back
Get-MerakiSNMP
Post
NAME Get-MerakiSNMP
SYNOPSIS
Short function to provide SNMP Details.
In order to use this Module you will need an API Key from your Dashboard.
SYNTAX
Get-MerakiSNMP [-ApiKey] <String> [-OrganisationID] <String> [<CommonParameters>]
DESCRIPTION
Short function to provide SNMP Details.
This function queries the Cisco Meraki API service https://dashboard.meraki.com/api/v0 and will be needed for use
with additional
commands within the module.
API Access is free but Rate Controlled and is limited to 5 calls per second (per organisation).
In order to use this Module you will need an API Key from your Dashboard. For access to the API, first enable the
API for your
organisation under Organiation > Settings > Dashboard API access.
After enabling the API, go to the my profile page to generate an API key. The API key is associated with a
Dashboard administrator account.
You can generate, revoke, and regenerate your API key on your profile.
PARAMETERS
-ApiKey <String>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-OrganisationID <String>
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Accepts Api Key as piped input.
Accepts Organisation ID as piped input.
OUTPUTS
The output from the API is sent as JSON and captured in a custom object.
{
"v2cEnabled": true,
"v3Enabled": false,
"v3AuthMode": null,
"v3PrivMode": null,
"peerIps": null,
"v2CommunityString": "o/-t35Mb",
"hostname": "n149.meraki.com",
"port": 16100
}
You can then select the items that you want to display.
NOTES
Author: Luke Leigh
Website: https://blog.lukeleigh.com/
LinkedIn: https://www.linkedin.com/in/lukeleigh/
GitHub: https://github.com/BanterBoy/
GitHubGist: https://gist.github.com/BanterBoy
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>
RELATED LINKS
https://github.com/BanterBoy/CiscoMeraki/wiki
SYNOPSIS
Short function to provide SNMP Details.
In order to use this Module you will need an API Key from your Dashboard.
SYNTAX
Get-MerakiSNMP [-ApiKey] <String> [-OrganisationID] <String> [<CommonParameters>]
DESCRIPTION
Short function to provide SNMP Details.
This function queries the Cisco Meraki API service https://dashboard.meraki.com/api/v0 and will be needed for use
with additional
commands within the module.
API Access is free but Rate Controlled and is limited to 5 calls per second (per organisation).
In order to use this Module you will need an API Key from your Dashboard. For access to the API, first enable the
API for your
organisation under Organiation > Settings > Dashboard API access.
After enabling the API, go to the my profile page to generate an API key. The API key is associated with a
Dashboard administrator account.
You can generate, revoke, and regenerate your API key on your profile.
PARAMETERS
-ApiKey <String>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-OrganisationID <String>
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Accepts Api Key as piped input.
Accepts Organisation ID as piped input.
OUTPUTS
The output from the API is sent as JSON and captured in a custom object.
{
"v2cEnabled": true,
"v3Enabled": false,
"v3AuthMode": null,
"v3PrivMode": null,
"peerIps": null,
"v2CommunityString": "o/-t35Mb",
"hostname": "n149.meraki.com",
"port": 16100
}
You can then select the items that you want to display.
NOTES
Author: Luke Leigh
Website: https://blog.lukeleigh.com/
LinkedIn: https://www.linkedin.com/in/lukeleigh/
GitHub: https://github.com/BanterBoy/
GitHubGist: https://gist.github.com/BanterBoy
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>
RELATED LINKS
https://github.com/BanterBoy/CiscoMeraki/wiki