Returns the Uplink status of Meraki Networks.
Get-MerakiOrganizationApplianceUplinkStatuses [-networkId <String>] [-serial <String>] [<CommonParameters>] Get-MerakiOrganizationApplianceUplinkStatuses [-networkId <String>] [-serial <String>] [-OrgId <String>] [<CommonParameters>] Get-MerakiOrganizationApplianceUplinkStatuses [-networkId <String>] [-serial <String>] [-ProfileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Filters the output by network Id. | false | true (ByValue, ByPropertyName) | * | ||
| String | Filters the output by Appliance serial number. Partial serial number can be specified bu using the * wildcard. i.e. "*HG4U" | false | true (ByValue, ByPropertyName) | * | ||
| String | false | false | ||||
| String | false | false |
The output type is the type of the objects that the cmdlet emits.
Returns the port configuration for a Meraki switch port.
Get-MerakiSwitchPort [-Serial] <String> [[-PortId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The switch serial number. | true | true (ByPropertyName) | |||
| String | The port Id. If Omitted all ports are returned | false | false |
The output type is the type of the objects that the cmdlet emits.
Returns the static routes for this network appliance.
Get-MerakiApplianceStaticRoutes [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Network Id. | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns the VLANs for the network appliance.
Get-MerakiApplianceVLANS [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The network Id. | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns VPN statistics for the given organization network.
Get-MerakiOrganizationApplianceVpnStats -id <String> [-perPage <Int32>] [-TimeSpan <Int32>] [-Summarize] [<CommonParameters>] Get-MerakiOrganizationApplianceVpnStats -id <String> [-perPage <Int32>] [-TimeSpan <Int32>] [-Summarize] [-OrgId <String>] [<CommonParameters>] Get-MerakiOrganizationApplianceVpnStats -id <String> [-perPage <Int32>] [-TimeSpan <Int32>] [-Summarize] [-ProfileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Network Id. | true | true (ByValue, ByPropertyName) | |||
| Int32 | The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. | false | false | 100 | ||
| Int32 | Number of seconds to return data for. default = 5. | false | false | 5 | ||
| SwitchParameter | Summarize the statistics, AN array op VPN peer objects or a summary object. |
false | false | False | ||
| String | Optional Organization Id. | false | false | |||
| String | Optional Profile Name | false | false |
Return the LAG configurations for a Meraki Network.
Get-MerakiSwitchLAG [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The network Id. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns a Meraki network switch stack.
Get-MerakiSwitchStack [-Id] <String> [[-StackId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | true | true (ByPropertyName) | |||
| String | The stack Id. | false | false |
The output type is the type of the objects that the cmdlet emits.
Returns a Meraki network switch stack.
Get-MerakiSwitchStack [-Id] <String> [[-StackId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | true | true (ByPropertyName) | |||
| String | The stack Id. | false | false |
The output type is the type of the objects that the cmdlet emits.
Returns the port configuration for a Meraki switch port.
Get-MerakiSwitchPort [-Serial] <String> [[-PortId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The switch serial number. | true | true (ByPropertyName) | |||
| String | The port Id. If Omitted all ports are returned | false | false |
The output type is the type of the objects that the cmdlet emits.
Returns an interface for a Meraki switch.
Get-MerakiSwitchRoutingInterface [-serial] <String> [[-interfaceId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The serial number of the switch. | true | true (ByPropertyName) | |||
| String | The interface Id. | false | false |
The output type is the type of the objects that the cmdlet emits.
Return a Meraki Switch stack routing interface(s).
Get-MerakiSwitchStackRoutingInterface [-NetworkId] <String> [-Id] <String> [[-interfaceId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The network Id. | true | true (ByPropertyName) | |||
| StackId | String | true | true (ByPropertyName) | |||
| String | The interface Id. If Omitted return all interfaces. | false | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns the Meraki switch stack routing interface DHCP setting for an interface.
Get-MerakiSwitchStackRoutingInterfaceDHCP [-interfaceId] <String> [-networkId] <String> [-stackId] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The interface Id. | true | true (ByPropertyName) | |||
| String | The network Id | true | true (ByPropertyName) | |||
| String | The Stack Id. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Retrieves static route(s) from the switch stack.
Get-MerakiSwitchStackRoutingStaticRoute [-NetworkId] <String> [-StackId] <String> [[-StaticRouteId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network. | true | true (ByPropertyName) | |||
| Id | String | The Id of the switch stack. | true | true (ByPropertyName) | ||
| String | The id of the static route. If Omitted returns all static routes. | false | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
New-MerakiNetworkSwitchStack
Create a new Switch Stack.
Create a new switch stack in a Meraki network
New-MerakiSwitchStack [-NetworkId] <String> [-Name] <String> [-Serials] <String[]> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network to create the stack in | true | false | |||
| String | The name of the stack | true | false | |||
| String[] | an array of switch serial numbers to add to the stack. | true | false |
The output type is the type of the objects that the cmdlet emits.
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| None | string | true | false | |||
| DestCidr | string | true | false | |||
| destPort | string | false | false | |||
| NetworkId | string | true | true (ByPropertyName) | |||
| None | string | true | false | |||
| srcCidr | string | true | false | |||
| srcPort | string | false | false | |||
| None | switch | false | false | |||
| None | string | true | false |
Add new URL patterns.
Add the provided allowed and blocked URL patterns to the content filtering rule.
Add-MerakiApplianceContentFilteringRules [-Id] <String> [[-allowedURLPatterns] <String[]>] [[-blockedURLPatterns] <String[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Network ID. | true | true (ByValue, ByPropertyName) | |||
| String[] | An array of allowed URL patterns. | false | false | |||
| String[] | An array of blocked URL patterns. | false | false |
The output type is the type of the objects that the cmdlet emits.
Add sites to the allowed and blocked URL patterns. PS> $Network | Add-MerakiNetworkApplianceContentFilteringRule -allowedUrlPatterns "xtz.com" -blockedUrlPatterns "badsite.com"
Add a static delegated prefix from a network
Add-MerakiApplianceDelegatedStaticPrefix [-Id] <String> [[-Description] <String>] [-Prefix] <String> [-Type] <String> [-Interfaces] <String[]> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of the network. | true | true (ByPropertyName) | ||
| String | A name or description for the prefix | false | false | |||
| String | A static IPv6 prefix | true | false | |||
| String | Type of the origin. Valid values are 'independent', 'internet' | true | false | |||
| String[] | An array of interfaces associated with the prefix. i.e. 'wan1' | true | false |
The output type is the type of the objects that the cmdlet emits.
Add a One to Many NAT mapping rule to an MX network
Add-MerakiApplianceFirewallNatRule [-Id] <String> [-Type] <String> [[-PublicIp] <String>] [-Uplink] <String> [[-PortRules] <PSObject[]>] [[-LanIp] <String>] [[-Name] <String>] [[-AllowedInbound] <PSObject>] [[-Protocol] <String>] [[-PublicPort] <String>] [[-LocalPort] <String>] [[-AllowedIps] <String[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of tye network. | true | true (ByPropertyName) | ||
| String | The type of rule, can be one of: 'OneToMany','OneToOne',or 'PortForwarding' | true | false | |||
| String | The IP address that will be used to access the internal resource from the WAN. This parameter is only valid for for OneToMany and OneToOne rules. |
false | false | |||
| String | The physical WAN interface on which the traffic will arrive ('internet1' or, if available, 'internet2') | true | false | |||
| PSObject[] | An array of associated forwarding rules with the following properties: localIp: string Local IP address to which traffic will be forwarded localPort: string Destination port of the forwarded traffic that will be sent from the MX to the specified host on the LAN. If you simply wish to forward the traffic without translating the port, this should be the same as the Public port name: string A description of the rule protocol: string 'tcp' or 'udp' publicPort: string Destination port of the traffic that is arriving on the WAN allowedIps: array[] Remote IP addresses or ranges that are permitted to access the internal resource via this port forwarding rule, or 'any' This property can be either a PsObject or a HashTable This property is only valid for OneToMany rules. |
false | false | |||
| String | The IP address of the server or device that hosts the internal resource that you wish to make available on the WAN This parameter is only valid for OneToOne or PortForwarding rules. |
false | false | |||
| String | A descriptive name for the rule. This parameter is only valid for OneToOne or PortForwarding rules. |
false | false | |||
| PSObject | The ports this mapping will provide access on, and the remote IPs that will be allowed access to the resource The parameter is only valid for OneToMany rules. |
false | false | |||
| String | TCP or UDP. Valid values are 'tcp', 'udp' The parameter is only valid for PortForwarding rules. |
false | false | |||
| String | A port or port ranges that will be forwarded to the host on the LAN. The parameter is only valid for PortForwarding rules. |
false | false | |||
| String | A port or port ranges that will receive the forwarded traffic from the WAN The parameter is only valid for PortForwarding rules. |
false | false | |||
| String[] | An array of ranges of WAN IP addresses that are allowed to make inbound connections on the specified ports or port ranges (or any) The parameter is only valid for PortForwarding rules. |
false | false |
The output type is the type of the objects that the cmdlet emits.
Add an inbound cellular firewall rule to an MX network.
Add-MerakiApplianceInboundCellularFirewallRule [-Id] <String> [[-Comment] <String>] [-Policy] <String> [[-SourceCIDR] <String>] [[-SourcePort] <String>] [[-Protocol] <String>] [-DestinationCIDR] <String> [[-DestinationPort] <String>] [-SyslogEnabled] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | true (ByPropertyName) | ||
| String | Description of the rule (optional) | false | false | |||
| String | 'allow' or 'deny' traffic specified by this rule | true | false | |||
| srcCidr | String | Comma-separated list of source IP address(es) (in IP or CIDR notation), or 'any' (note: FQDN not supported for source addresses) | false | false | ||
| srcPort | String | Comma-separated list of source port(s) (integer in the range 1-65535), or 'any' | false | false | any | |
| String | The type of protocol (must be 'tcp', 'udp', 'icmp', 'icmp6' or 'any') | false | false | any | ||
| destCidr | String | Comma-separated list of destination IP address(es) (in IP or CIDR notation), fully-qualified domain names (FQDN) or 'any' | true | false | ||
| destPort | String | Comma-separated list of destination port(s) (integer in the range 1-65535), or 'any' | false | false | any | |
| SwitchParameter | Log this rule to syslog (true or false, boolean value) - only applicable if a syslog has been configured (optional) | false | false | False |
Adds an inbound firewall rule to the network.
Add-MerakiApplianceInboundFirewallRule [-Id] <String> [-Policy] <String> [-protocol] <String> [[-SourcePort] <String>] [-SourceCidr] <String> [-DestinationCidr] <String> [[-DestinationPort] <String>] [-SyslogEnabled] [-Comment] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | true | true (ByPropertyName) | |||
| String | 'allow' or 'deny' traffic specified by this rule | true | false | |||
| String | The type of protocol (must be 'tcp', 'udp', 'icmp', 'icmp6' or 'any') | true | false | |||
| srcPort | String | Comma-separated list of source port(s) (integer in the range 1-65535), or 'any' | false | false | any | |
| srcCidr | String | Comma-separated list of source IP address(es) (in IP or CIDR notation), or 'any' (note: FQDN not supported for source addresses) | true | false | ||
| DestCidr | String | Comma-separated list of destination IP address(es) (in IP or CIDR notation), fully-qualified domain names (FQDN) or 'any' | true | false | ||
| destPort | String | Comma-separated list of destination port(s) (integer in the range 1-65535), or 'any' | false | false | any | |
| SwitchParameter | Log this rule to syslog (true or false, boolean value) - only applicable if a syslog has been configured (optional) | false | false | False | ||
| String | Description of the rule (optional) | true | false |
Add a Level 3 Firewall rule.
Adds a Level 3 firewall rule to a Meraki Appliance.
Add-MerakiApplianceL3FirewallRule [-Id] <String> [[-Policy] <String>] [[-Comment] <String>] [[-Protocol] <String>] [[-SourceCIDR] <String>] [[-SourcePort] <String>] [[-DestinationCIDR] <String>] [[-DestinationPort] <String>] [-SyslogEnabled] [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Network ID. | true | true (ByPropertyName) | ||
| String | The Policy for this rule. | false | false | |||
| String | Description of the rule. | false | false | |||
| String | The protocol to use | false | false | |||
| String | Comma-separated list of source IP address(es) (in IP or CIDR notation), or 'any' (note: FQDN not supported for source addresses) | false | false | |||
| String | Comma-separated list of source port(s) (integer in the range 1-65535), or 'any' | false | false | any | ||
| String | Comma-separated list of destination IP address(es) (in IP or CIDR notation), fully-qualified domain names (FQDN) or 'any' | false | false | |||
| String | Comma-separated list of destination port(s) (integer in the range 1-65535), or 'any' | false | false | any | ||
| SwitchParameter | Log this rule to syslog - only applicable if a syslog has been configured (optional) | false | false | False | ||
| SwitchParameter | Return the newly created rule. | false | false | False |
Add a new MX L7 firewall rules for an MX network.
Add-MerakiApplianceL7FirewallRule [-Id] <String> [-Type] <String> [-Value] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id if the Network. | true | true (ByPropertyName) | ||
| String | Type of the L7 rule. One of: 'application', 'applicationCategory', 'host', 'port', 'ipRange' | true | false | |||
| String | The 'value' of what you want to block. Format of 'value' varies depending on type of the rule. The application categories and application ids can be retrieved from the the 'Get-MerakiNetworkApplianceApplicationCategories' endpoint. The countries follow the two-letter ISO 3166-1 alpha-2 format |
true | false |
The output type is the type of the objects that the cmdlet emits.
Adds a static routes for an MX or teleworker network.
Add-MerakiApplianceStaticRoute [-id] <String> [-Name] <String> [-Subnet] <String> [-NextHop] <String> [[-NextHopVlanID] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of the Network. | true | true (ByPropertyName) | ||
| String | The name of the new static route | true | false | |||
| String | The subnet of the static route | true | false | |||
| GatewayIp | String | true | false | |||
| GatewayVlanID | String | false | false |
The output type is the type of the objects that the cmdlet emits.
Creates a VLAN on the appliance in the specified network.
Add-MerakiApplianceVlan [-NetworkId] <String> [-VlanId] <String> [-Name] <String> [[-Subnet] <String>] [[-ApplianceIp] <String>] [[-GroupPolicyId] <String>] [[-TemplateVlanType] <String>] [[-CIDR] <String>] [[-Mask] <Int32>] [-Ipv6Enabled] [[-Ipv6PrefixAssignments] <Hashtable[]>] [-MandatoryDHCP] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The ID of the network to create the VLAN. | true | false | |||
| String | The VLAN ID of the new VLAN (must be between 1 and 4094). | true | false | |||
| String | The name of the new VLAN. | true | false | |||
| String | The subnet of the VLAN. | false | false | |||
| String | The local IP of the appliance on the VLAN | false | false | |||
| String | The id of the desired group policy to apply to the VLAN | false | false | |||
| String | Type of subnetting of the VLAN. Applicable only for template network. Valid values are 'same', 'unique'. | false | false | |||
| String | CIDR of the pool of subnets. Applicable only for template network. Each network bound to the template will automatically pick a subnet from this pool to build its own VLAN. | false | false | |||
| Int32 | Mask used for the subnet of all bound to the template networks. Applicable only for template network. | false | false | 0 | ||
| SwitchParameter | Enable IPv6 on VLAN. | false | false | False | ||
| Hashtable[] | Prefix assignments on the VLAN | false | false | |||
| SwitchParameter | Mandatory DHCP will enforce that clients connecting to this VLAN must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate. Only available on firmware versions 17.0 and above | false | false | False |
Create a network
Create a network in an organization
Add-MerakiNetwork -Name <String> -ProductTypes <String[]> [-TimeZone <String>] [-Notes <String>] [-Tags <String[]>] [-CopyFromNetworkId <String>] [<CommonParameters>] Add-MerakiNetwork -Name <String> -ProductTypes <String[]> [-TimeZone <String>] [-Notes <String>] [-Tags <String[]>] [-CopyFromNetworkId <String>] [-OrgID <String>] [<CommonParameters>] Add-MerakiNetwork -Name <String> -ProductTypes <String[]> [-TimeZone <String>] [-Notes <String>] [-Tags <String[]>] [-CopyFromNetworkId <String>] [-profileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The name of the network | true | false | |||
| String[] | The product type(s) of the new network. If more than one type is included, the network will be a combined network. | true | false | |||
| String | Time zone name from the ICANN tz database | false | false | |||
| String | Add any notes or additional information about this network here. | false | false | |||
| String[] | A list of tags to be applied to the network | false | false | |||
| String | The ID of the network to copy configuration from. Other provided parameters will override the copied configuration, except type which must match this network's type exactly. | false | false | |||
| String | Optional Organizational ID. | false | false | |||
| String | Optional Profile name. | false | false |
The output type is the type of the objects that the cmdlet emits.
Adds an Access Control entry to the switch access control list.
Add-MerakiSwitchAccessControlEntry [-NetworkId] <String> [[-Vlan] <String>] [[-SourcePort] <String>] [[-SourceCidr] <String>] [[-Protocol] <String>] [[-Policy] <String>] [[-IpVersion] <String>] [[-DestinationPort] <String>] [[-DestinationCidr] <String>] [[-Comment] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network. | true | false | |||
| String | Incoming traffic VLAN | false | false | any | ||
| SrcPort | String | The source port. | false | false | any | |
| SrcCidr | String | Source IP address (in IP or CIDR notation) | false | false | any | |
| String | The type of protocol | false | false | any | ||
| String | allow' or 'deny' traffic specified by this rule | false | false | |||
| String | IP address version | false | false | |||
| DstPort | String | The destination port. | false | false | any | |
| DstCidr | String | Destination IP address (in IP or CIDR notation) | false | false | any | |
| String | Description of the rule (optional) | false | false |
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| None | string | false | false | |||
| None | string | false | false | |||
| None | int | false | false | |||
| None | string | true | false | |||
| None | switch | false | false | |||
| None | string | true | false | |||
| None | string | true | false | |||
| None | psobject | false | false | |||
| None | switch | false | false | |||
| None | psobject[] | false | false | |||
| None | switch | false | false | |||
| None | string | false | false | |||
| None | psobject[] | true | false | |||
| None | switch | false | false | |||
| None | switch | false | false | |||
| None | string[] | false | false | |||
| None | switch | false | false |
Create a Link Aggregation Port
Create a Link Aggregation Port on Meraki Switches.
Add-MerakiSwitchLAG [-NetworkId] <String> [-SwitchPorts] <Hashtable[]> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Network ID to add the LAG to. | true | false | |||
| Hashtable[] | Switch Ports to use in the LAG. SwitchPorts is a an array of hashtable objects. These objects are either switch ports or switch profile ports. Defined as below. switchPorts: array[] - Array of switch or stack ports for creating aggregation group. Minimum 2 and maximum 8 ports are supported. portId*:string - Port identifier of switch port. For modules, the identifier is "SlotNumber_ModuleType_PortNumber" (Ex: "1_8X10G_1"), otherwise it is just the port number (Ex: "8"). serial*:string - Serial number of the switch. switchProfilePorts: array[] - Array of switch profile ports for creating aggregation group. Minimum 2 and maximum 8 ports are supported. portId*:string - Port identifier of switch port. For modules, the identifier is "SlotNumber_ModuleType_PortNumber" (Ex: "1_8X10G_1"), otherwise it is just the port number (Ex: "8"). profile*:string - Profile identifier. |
true | false |
The output type is the type of the objects that the cmdlet emits.
Create a port schedule
Create a Meraki Switch port schedule
Add-MerakiSwitchPortSchedule [-NetworkId] <String> [-Name] <String> [[-PortSchedule] <PSObject[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Network to apply the port schedule to | true | false | |||
| String | The name of the port schedule | true | false | |||
| PSObject[] | The schedule for switch port scheduling. Schedules are applied to days of the week. When it's empty, default schedule with all days of a week are configured. Any unspecified day in the schedule is added as a default schedule configuration of the day. An object of port schedules. Schedule consist of: Day of week (Monday, Tuesday, etc) Active: boolean - Whether the schedule is active (true) or inactive (false) during the time specified between 'from' and 'to'. Defaults to true. from:string - The time, from '00:00' to '24:00'. Must be less than the time specified in 'to'. Defaults to '00:00'. Only 30 minute increments are allowed. to: string - The time, from '00:00' to '24:00'. Must be greater than the time specified in 'from'. Defaults to '24:00'. Only 30 minute increments are allowed. (see examples) |
false | false |
The output type is the type of the objects that the cmdlet emits.
The following example show how to create a port schedule.
Create a QOS rule.
Create a QOS rule for Meraki network switches.
Add-MerakiSwitchQosRule [-NetworkId] <String> [-Vlan] <Int32> [[-Protocol] <String>] [[-SourcePort] <Int32>] [[-SourcePortRange] <String>] [[-DestinationPort] <Int32>] [[-DestinationPortRange] <String>] [[-dscp] <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Network ID fo the network. | true | false | |||
| Int32 | The VLAN of the incoming packet. A null value will match any VLAN. | true | false | 0 | ||
| String | The protocol of the incoming packet. Can be one of "ANY", "TCP" or "UDP". Default value is "ANY" | false | false | ANY | ||
| srcPort | Int32 | The source port of the incoming packet. Applicable only if protocol is TCP or UDP. | false | false | 0 | |
| srcPortRange | String | The source port range of the incoming packet. Applicable only if protocol is set to TCP or UDP. Example: 70-80 | false | false | ||
| dstPort | Int32 | The destination port of the incoming packet. Applicable only if protocol is TCP or UDP. | false | false | 0 | |
| dstPortRange | String | The destination port range of the incoming packet. Applicable only if protocol is set to TCP or UDP. Example: 70-80 | false | false | ||
| Int32 | DSCP tag. Set this to -1 to trust incoming DSCP. Default value is 0 | false | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Add a routing interface to a switch.
Add a VLAN interface to a Meraki switch.
Add-MerakiSwitchRoutingInterface [-Serial] <String> [-VlanId] <Int32> [-Name] <String> [[-Subnet] <String>] [[-DefaultGateway] <String>] [[-InterfaceIp] <String>] [[-MulticastRouting] <String>] [[-Ipv6Address] <String>] [[-Ipv6AssignmentMode] <String>] [[-Ipv6Gateway] <String>] [[-Ipv6Prefix] <String>] [[-OspfCost] <Int32>] [[-OspfArea] <String>] [-OspfIsPassive] [[-OspfV3Cost] <Int32>] [[-OspfV3Area] <String>] [-OspfV3IsPassive] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Serial number of the switch. | true | true (ByPropertyName) | |||
| Int32 | The VLAN this routed interface is on. VLAN must be between 1 and 4094. | true | false | 0 | ||
| String | A friendly name or description for the interface or VLAN. | true | false | |||
| String | The network that this routed interface is on, in CIDR notation (ex. 10.1.1.0/24 | false | false | |||
| String | The next hop for any traffic that isn't going to a directly connected subnet or over a static route. This IP address must exist in a subnet with a routed interface. Required if this is the first IPv4 interface. |
false | false | |||
| String | The IP address this switch will use for layer 3 routing on this VLAN or subnet. This cannot be the same as the switch's management IP. | false | false | |||
| String | Enable multicast support if, multicast routing between VLANs is required. Options are: 'disabled', 'enabled' or 'IGMP snooping querier'. Default is 'disabled'. |
false | false | |||
| String | The IPv6 address of the interface. Required if assignmentMode is 'static'. Must not be included if assignmentMode is 'eui-64'. | false | false | |||
| String | The IPv6 assignment mode for the interface. Can be either 'eui-64' or 'static'. | false | false | |||
| String | The IPv6 default gateway of the interface. Required if prefix is defined and this is the first interface with IPv6 configured for the switch. | false | false | |||
| String | The IPv6 prefix of the interface. Required if IPv6 object is included. | false | false | |||
| Int32 | The path cost for this interface. Defaults to 1, but can be increased up to 65535 to give lower priority. | false | false | 0 | ||
| String | The OSPF area to which this interface should belong. Can be either 'disabled' or the identifier of an existing OSPF area. Defaults to 'disabled'. | false | false | |||
| SwitchParameter | When enabled, OSPF will not run on the interface, but the subnet will still be advertised. | false | false | False | ||
| Int32 | The path cost for this interface. Defaults to 1, but can be increased up to 65535 to give lower priority. | false | false | 0 | ||
| String | The OSPFv3 area to which this interface should belong. Can be either 'disabled' or the identifier of an existing OSPFv3 area. Defaults to 'disabled'. |
false | false | |||
| SwitchParameter | When enabled, OSPFv3 will not run on the interface, but the subnet will still be advertised. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Create a Static Route
Create a Static route on a Meraki switch
Add-MerakiSwitchRoutingStaticRoute [-Serial] <String> [-Name] <String> [-NextHopIp] <String> [-Subnet] <String> [-AdvertiseViaOspfEnabled] [-PreferOverOspfRoutesEnabled] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The serial number of the switch | true | false | |||
| String | The name of the static route | true | false | |||
| String | IP address of the next hop device to which the device sends its traffic for the subnet | true | false | |||
| String | The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24) | true | false | |||
| SwitchParameter | Option to advertise static route via OSPF | false | false | False | ||
| SwitchParameter | Option to prefer static route over OSPF routes | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Add Meraki Switch stack routing interface
Add an interface to a Meraki network.
Add-MerakiSwitchStackRoutingInterface [-NetworkId] <String> [-StackId] <String> [-VlanId] <Int32> [-Name] <String> [[-Subnet] <String>] [[-InterfaceIp] <String>] [[-DefaultGateway] <String>] [[-Ipv6Address] <String>] [[-Ipv6AssignmentMode] <String>] [[-Ipv6Gateway] <String>] [[-Ipv6Prefix] <String>] [[-OspfCost] <Int32>] [[-OspfArea] <String>] [-OspfIsPassiveEnabled] [[-OspfV3Cost] <Int32>] [[-OspfV3Area] <String>] [-OspfV3IsPassiveEnabled] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network. | true | false | |||
| String | The Id of the switch stack. | true | false | |||
| Int32 | The VLAN this routed interface is on. VLAN must be between 1 and 4094 | true | false | 0 | ||
| String | A friendly name or description for the interface or VLAN. | true | false | |||
| String | The network that this routed interface is on, in CIDR notation (ex. 10.1.1.0/24). | false | false | |||
| String | The IP address this switch stack will use for layer 3 routing on this VLAN or subnet. This cannot be the same as the switch's management IP. | false | false | |||
| String | The next hop for any traffic that isn't going to a directly connected subnet or over a static route. This IP address must exist in a subnet with a routed interface. | false | false | |||
| String | The IPv6 address of the interface. Required if assignmentMode is 'static'. Must not be included if assignmentMode is 'eui-64'. | false | false | |||
| String | The IPv6 assignment mode for the interface. Can be either 'eui-64' or 'static'. | false | false | |||
| String | The IPv6 default gateway of the interface. Required if prefix is defined and this is the first interface with IPv6 configured for the stack. | false | false | |||
| String | The IPv6 prefix of the interface. Required if IPv6 object is included. | false | false | |||
| Int32 | The path cost for this interface. Defaults to 1, but can be increased up to 65535 to give lower priority. | false | false | 0 | ||
| String | The OSPF area to which this interface should belong. Can be either 'disabled' or the identifier of an existing OSPF area. Defaults to 'disabled'. | false | false | |||
| SwitchParameter | When enabled, OSPF will not run on the interface, but the subnet will still be advertised. | false | false | False | ||
| Int32 | The path cost for this interface. Defaults to 1, but can be increased up to 65535 to give lower priority. | false | false | 0 | ||
| String | The OSPF area to which this interface should belong. Can be either 'disabled' or the identifier of an existing OSPF area. Defaults to 'disabled'. | false | false | |||
| SwitchParameter | When enabled, OSPF will not run on the interface, but the subnet will still be advertised. | false | false | False |
Add a switch to a stack.
Add a new switch to an existing Meraki switch stack
Add-MerakiSwitchStackSwitch [-NetworkId] <String> [-StackId] <String> [-serial] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network | true | false | |||
| String | The ID of the stack | true | false | |||
| String | The serial number of the new switch | true | false |
The output type is the type of the objects that the cmdlet emits.
Connect a template to a network
Connect a Meraki network to a configuration template
Connect-MerakiNetworkToTemplate [-NetworkId] <String> [-ConfigTemplateId] <String> [-AutoBind] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network to connect | true | false | |||
| String | The Id of the configuration template | true | false | |||
| SwitchParameter | Optional boolean indicating whether the network's switches should automatically bind to profiles of the same model. Defaults to false if left unspecified. This option only affects switch networks and switch templates. Auto-bind is not valid unless the switch template has at least one profile and has at most one profile per switch model. |
false | false | False |
The output type is the type of the objects that the cmdlet emits.
Disconnect a network from a template
Disconnect a Meraki Network from a configuration template
Disconnect-MerakiNetworkFromTemplate [-NetworkId] <String> [-RetainConfigs] [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The ID of the network | true | false | |||
| SwitchParameter | Optional boolean to retain all the current configs given by the template. | false | false | False | ||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
The output type is the type of the objects that the cmdlet emits.
Returns the Cellular firewall rules for this network.
Get-MerakiApplianceCellularFirewallRules [-Id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Network ID to retrieve the rules from. | true | true (ByPropertyName) |
Returns the security events for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.
Get-MerakiApplianceClientSecurityEvents -Id <String> -ClientId <String> [-PerPage <Int32>] [<CommonParameters>] Get-MerakiApplianceClientSecurityEvents -Id <String> -ClientId <String> -StartDate <DateTime> -EndDate <DateTime> [-PerPage <Int32>] [<CommonParameters>] Get-MerakiApplianceClientSecurityEvents -Id <String> -ClientId <String> -Days <Int32> [-PerPage <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | true (ByPropertyName) | ||
| String | The ID of the client. | true | true (ByPropertyName) | |||
| DateTime | The beginning of the timespan for the data. Data is gathered after the specified StartDate value. The maximum look back period is 791 days from today. | true | false | |||
| DateTime | The end of the timespan for the data. t1 can be a maximum of 791 days after StartDate. | true | false | |||
| Int32 | The timespan for which the information will be fetched. If specifying timespan, do not specify parameters StartDate and EndDate. The value must be less than or equal to 791 days. The default is 31 days. | true | false | 0 | ||
| Int32 | The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. | false | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Retrieve content filtering Rules for a network
Get-MerakiApplianceContentFiltering [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | true | true (ByValue, ByPropertyName) |
Returns the content filtering categories for this network.*
Get-MerakiApplianceContentFilteringCategories [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Network ID. | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Return a static delegated prefix from a network
Get-MerakiApplianceDelegatesStaticPrefix [-Id] <String> [-PrefixId] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | true (ByPropertyName) | ||
| String | The Static Prefix Id. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Retrieves static delegated prefixes for a network.
Get-MerakiApplianceDelegatesStaticPrefixes [-Id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of the network. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns DHCP Subnets for an appliance.
Returns information and statistics for an appliances DHCP subnets. Including used count and free count.
Get-MerakiApplianceDhcpSubnets [-serial] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The serial number of the appliance. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Return the NAT mapping rules for an MX network
Get-MerakiApplianceFirewallNatRules [-Id] <String> [-Type] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | true (ByPropertyName) | ||
| String | The type of mapping rule. One of OneToMany, OneToOne, or PortForwarding | true | false |
The output type is the type of the objects that the cmdlet emits.
Return the inbound cellular firewall rules for an MX network
Get-MerakiApplianceInboundCellularFirewallRules [-Id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of the network. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Return the inbound firewall rules for an MX network
Get-MerakiApplianceInboundFirewallRules [-Id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of the network. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Retrieve the network appliance level 3 firewall rules.
Get-MerakiApplianceL3FirewallRules [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The network Id. | true | true (ByPropertyName) |
Return the L7 firewall application categories and their associated applications for an MX network.
Get-MerakiApplianceL7ApplicationCategories [-Id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the Network. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns the MX L7 firewall rules for an MX network.
Get-MerakiApplianceL7FirewallRules [-Id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of the network. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Return per-port VLAN settings for a single MX port.
Get-MerakiAppliancePort [-NetworkId] <String> [-Number] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| Id | String | true | true (ByPropertyName) | |||
| String | The port number | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns the port configuration for the Network Appliance.
Get-MerakiAppliancePorts [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The network Id. | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
List the security events for a network
Get-MerakiApplianceSecurityEvents -Id <String> [-PerPage <Int32>] [<CommonParameters>] Get-MerakiApplianceSecurityEvents -Id <String> -StartDate <DateTime> -EndDate <DateTime> [-PerPage <Int32>] [<CommonParameters>] Get-MerakiApplianceSecurityEvents -Id <String> -Days <Int32> [-PerPage <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network | true | true (ByPropertyName) | ||
| DateTime | The beginning of the timespan for the data. Data is gathered after the specified StartDate value. The maximum look back period is 791 days from today. | true | false | |||
| DateTime | The end of the timespan for the data. t1 can be a maximum of 791 days after StartDate. | true | false | |||
| Int32 | The timespan for which the information will be fetched. If specifying timespan, do not specify parameters StartDate and EndDate. The value must be less than or equal to 791 days. The default is 31 days. | true | false | 0 | ||
| Int32 | The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. | false | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Returns all supported intrusion settings for an organization
Get-MerakiApplianceSecurityIntrusion [-Id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns all supported malware settings for an MX network.
Get-MerakiApplianceSecurityMalwareSettings [-Id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Return single LAN configuration.
Get-MerakiApplianceSingleLan [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The id of the Network. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns a Meraki Network appliance Site-to-Site VPN configuration.
Get-MerakiApplianceSiteToSiteVPN [-id] <String> [-hr] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The network Id. | true | true (ByValue, ByPropertyName) | |||
| SwitchParameter | Formats the output into 2 tables. Hubs and Subnets. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Returns the static routes for this network appliance.
Get-MerakiApplianceStaticRoutes [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Network Id. | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns a network appliance VLAN
Get-MerakiApplianceVLAN [-networkId] <String> [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Network Id. | true | true (ByValue, ByPropertyName) | |||
| String | The VLAN Id. | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns the VLANs for the network appliance.
Get-MerakiApplianceVLANS [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The network Id. | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns a Meraki Device.
Get-MerakiDevice [-Serial] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The serial number of the device. | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Return the uplink settings for an MX appliance
Get-MerakiDeviceApplianceUplinks [-Serial] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Serial number of the MX device. | true | true (ByPropertyName) |
Returns clients associated with the device.
List the clients of a device, up to a maximum of a month ago. The usage of each client is returned in kilobytes. If the device is a switch, the switchport is returned; otherwise the switchport field is null.
Get-MerakiDeviceClients -serial <String> [<CommonParameters>] Get-MerakiDeviceClients -serial <String> -StartDate <DateTime> [<CommonParameters>] Get-MerakiDeviceClients -serial <String> -StartDate <DateTime> [<CommonParameters>] Get-MerakiDeviceClients -serial <String> -StartDate <DateTime> [<CommonParameters>] Get-MerakiDeviceClients -serial <String> -Days <Int32> [<CommonParameters>] Get-MerakiDeviceClients -serial <String> -Days <Int32> [<CommonParameters>] Get-MerakiDeviceClients -serial <String> -Days <Int32> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The serial number of the device. | true | true (ByValue, ByPropertyName) | |||
| DateTime | The starting date to retrieve data. Maximum 31 days prior to today. | true | false | |||
| Int32 | Number of days prior to today to retrieve data. Maximum of 31 days prior to today. | true | false | 0 |
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| None | string | true | true (ByPropertyName) |
Returns a Meraki Network.
Get-MerakiNetwork [-networkID] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| Id | String | The ID of the network. | true | false |
The output type is the type of the objects that the cmdlet emits.
Return the application usage data for clients.
Return the application usage data for clients. Usage data is in kilobytes.
Clients can be identified by client keys or either the MACs or IPs depending on whether the network uses Track-by-IP.
Get-MerakiNetworkClientApplicationUsage -Id <String> [-Clients <String>] [-SSIDNumber <Int32>] [-PerPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiNetworkClientApplicationUsage -Id <String> [-Clients <String>] [-SSIDNumber <Int32>] -StartDate <DateTime> -EndDate <DateTime> [-PerPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiNetworkClientApplicationUsage -Id <String> [-Clients <String>] [-SSIDNumber <Int32>] -StartDate <DateTime> -EndDate <DateTime> [-PerPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiNetworkClientApplicationUsage -Id <String> [-Clients <String>] [-SSIDNumber <Int32>] -StartDate <DateTime> -EndDate <DateTime> [-PerPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiNetworkClientApplicationUsage -Id <String> [-Clients <String>] [-SSIDNumber <Int32>] -Days <Int32> [-PerPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiNetworkClientApplicationUsage -Id <String> [-Clients <String>] [-SSIDNumber <Int32>] -Days <Int32> [-PerPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiNetworkClientApplicationUsage -Id <String> [-Clients <String>] [-SSIDNumber <Int32>] -Days <Int32> [-PerPage <Int32>] [-Pages <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Network Id. | true | true (ByPropertyName) | ||
| String | A array of client keys, MACs or IPs. | false | false | |||
| Int32 | An SSID number to include. If not specified, usage histories application usage for all SSIDs will be returned. | false | false | 0 | ||
| DateTime | The starting date to retrieve date (Cannot be more than 31 days before today). | true | false | |||
| DateTime | The ending date to retrieve data (Cannot be more than 31 days after today). | true | false | |||
| Int32 | Number of days before to day to retrieve date. (Cannot be more than 31 days before today). Default is 1 day. | true | false | 0 | ||
| Int32 | The number of entries per page returned. Acceptable range is 3 - 1000. | false | false | 0 | ||
| Int32 | Number of pages to return. Default is all. | false | false | 1 |
The output type is the type of the objects that the cmdlet emits.
Returns traffic consumption rates for all clients.
Returns a time series of total traffic consumption rates for all clients on a network within a given timespan, in megabits per second.
Get-MerakiNetworkClientBandwidthUsage -id <String> [-perPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiNetworkClientBandwidthUsage -id <String> -StartDate <DateTime> -EndDate <DateTime> [-perPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiNetworkClientBandwidthUsage -id <String> -StartDate <DateTime> -EndDate <DateTime> [-perPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiNetworkClientBandwidthUsage -id <String> -StartDate <DateTime> -EndDate <DateTime> [-perPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiNetworkClientBandwidthUsage -id <String> -Days <Int32> [-perPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiNetworkClientBandwidthUsage -id <String> -Days <Int32> [-perPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiNetworkClientBandwidthUsage -id <String> -Days <Int32> [-perPage <Int32>] [-Pages <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | Network Id | true | true (ByPropertyName) | ||
| StartTime | DateTime | The beginning of the timespan for the data. Must be no more than 31 days from today. | true | false | ||
| EndTime | DateTime | The end time for the data. Must be no more than 31 days after StartTime. | true | false | ||
| Int32 | Number fo days prior to today to return data. | true | false | 0 | ||
| Int32 | The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. | false | false | 0 | ||
| Int32 | Number of pages to return. Default is all. | false | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Returns aggregated connectivity info for a given client on this network. Clients are identified by their MAC.
Returns aggregated connectivity info for a given client on this network for the given time period, band, SSID VLAN of AP Tag.
Get-MerakiNetworkClientConnectionStats -Id <String> -ClientId <String> [-Band <String>] [-SSID <String>] [-VLAN <Int32>] [-APTag <String>] [<CommonParameters>] Get-MerakiNetworkClientConnectionStats -Id <String> -ClientId <String> -StartDate <DateTime> [-Band <String>] [-SSID <String>] [-VLAN <Int32>] [-APTag <String>] [<CommonParameters>] Get-MerakiNetworkClientConnectionStats -Id <String> -ClientId <String> -StartDate <DateTime> -EndDate <DateTime> [-Band <String>] [-SSID <String>] [-VLAN <Int32>] [-APTag <String>] [<CommonParameters>] Get-MerakiNetworkClientConnectionStats -Id <String> -ClientId <String> -StartDate <DateTime> -EndDate <DateTime> [-Band <String>] [-SSID <String>] [-VLAN <Int32>] [-APTag <String>] [<CommonParameters>] Get-MerakiNetworkClientConnectionStats -Id <String> -ClientId <String> -EndDate <DateTime> [-Band <String>] [-SSID <String>] [-VLAN <Int32>] [-APTag <String>] [<CommonParameters>] Get-MerakiNetworkClientConnectionStats -Id <String> -ClientId <String> -Days <Int32> [-Band <String>] [-SSID <String>] [-VLAN <Int32>] [-APTag <String>] [<CommonParameters>] Get-MerakiNetworkClientConnectionStats -Id <String> -ClientId <String> -Days <Int32> [-Band <String>] [-SSID <String>] [-VLAN <Int32>] [-APTag <String>] [<CommonParameters>] Get-MerakiNetworkClientConnectionStats -Id <String> -ClientId <String> -Days <Int32> [-Band <String>] [-SSID <String>] [-VLAN <Int32>] [-APTag <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Network Id. | true | true (ByPropertyName) | |||
| String | true | true (ByPropertyName) | ||||
| DateTime | The starting date to return data. Must be no more that 7 days before today. | true | false | |||
| DateTime | The ending date to return data. Must be no more than 7 days before today. | true | false | |||
| Int32 | The number of days prior to today to return data. Must be no more that 7 days before today. | true | false | 0 | ||
| String | Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information. | false | false | |||
| String | Filter results by SSID. | false | false | |||
| Int32 | Filter results by VLAN. | false | false | 0 | ||
| String | Filter results by AP Tag. | false | false |
The output type is the type of the objects that the cmdlet emits.
Returns clients connections to the Network.
Returns a collection of client objects that are or have connected to the network withing the given time period.
Get-MerakiNetworkClients [-id] <String> [[-Days] <Int32>] [[-PerPage] <Int32>] [[-Pages] <Int32>] [[-Statuses] <String>] [[-Mac] <String>] [[-IP] <String>] [[-PskGroup] <String>] [[-OS] <String>] [[-Description] <String>] [[-VLAN] <String>] [[-recentDeviceConnections] <String[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The network Id. | true | true (ByValue, ByPropertyName) | ||
| Int32 | Number of days back from today to retrieve client connections. If specified do not specify StartDate or EndDate (cannot be more than 31 days from today) | false | false | 0 | ||
| Int32 | Sets the number of items returned per page. | false | false | 0 | ||
| Int32 | Sets the number of pages returned. Default is 1, 0 returns all pages. | false | false | 1 | ||
| String | Filters clients based on status. Can be one of 'Online' or 'Offline'. | false | false | |||
| String | Filters clients based on a partial or full match for the mac address field. | false | false | |||
| String | Filters clients based on a partial or full match for the ip address field | false | false | |||
| String | Filters clients based on partial or full match for the iPSK name field. | false | false | |||
| String | Filters clients based on a partial or full match for the os (operating system) field. | false | false | |||
| String | Filters clients based on a partial or full match for the description field. | false | false | |||
| String | Filters clients based on the full match for the VLAN field. | false | false | |||
| String[] | Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'. | false | false |
The output type is the type of the objects that the cmdlet emits.
Get the Network Devices for a Network.
Get-MerakiNetworkDevices [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Network ID. | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns Network Event.
Returns network events for this network.
Get-MerakiNetworkEvents [-id] <String> [-ProductType] <String> [[-IncludedEventTypes] <String[]>] [[-ExcludedEventTypes] <String[]>] [[-deviceMac] <String>] [[-deviceName] <String>] [[-deviceSerial] <String>] [[-clientName] <String>] [[-clientIP] <String>] [[-clientMac] <String>] [[-smDeviceName] <String>] [[-smDeviceMac] <String>] [[-PerPage] <Int32>] [[-Pages] <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The network Id. | true | true (ByValue, ByPropertyName) | |||
| String | The product type to pull events for. | true | false | |||
| String[] | An array of event types to include.* | false | false | |||
| String[] | An array of event types to exclude.* | false | false | |||
| String | Filter results by Mac Address | false | false | |||
| String | Filter results by device name. | false | false | |||
| String | Filter results by device serial number. | false | false | |||
| String | Filter results bu client name. | false | false | |||
| String | Filter results by client IP. | false | false | |||
| String | Filter results by client MAC. | false | false | |||
| String | Filter device bu System Manager device name. | false | false | |||
| String | Filter results by System Manager device MAC. | false | false | |||
| Int32 | Number of entries per page. 3-1000, default = 10. | false | false | 0 | ||
| Int32 | false | false | 1 |
The output type is the type of the objects that the cmdlet emits.
Get content filtering network events for a network.
PS> Get-MerakiNetworks |{$_.Name -like "Dallas"} | Get-MerakiNetworkEvents -includedEventTypes 'cf_block' -ProductType appliance
EXAMPLE 2
Get network events for a specific client PS> Get-MerakiNetworkEvents -clientName 'DALJohnDoe'EXAMPLE 3
Paging:
The maximum number of events you can retrieve per call is 1000. There are many events and 1000 events may only span a time period of a few minutes.
To retrieve more events you can use subsequent function calls with the paging parameters.
In the following command we retrieve the the content filtering events for the Dallas network for the month of June.
PS> Get-MerakiNetworks |{$_.Name -like "Dallas"} | Get-MerakiNetworkEvents -includedEventTypes 'cf_block' -ProductType appliance -startingAfter "06/01/2020" -endingBefore "06/30/2020" -pageSize 50
EXAMPLE 4
This call will retrieve the first 50 events that meet the time span specified.
There are significantly more events that meet this criteria.
To retrieve the next page of events reissue the call and append the -next paging parameter.
PS>Get-MerakiNetworks |{$_.Name -like "Dallas"} | Get-MerakiNetworkEvents -includedEventTypes 'cf_block' -ProductType appliance -startingAfter "06/01/2020" -endingBefore "06/30/2020" -pageSize 50 -next
Returns all event types supported by this network.
Get-MerakiNetworkEventTypes [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The network ID. | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Get all Meraki Networks.
Get all Meraki networks in an organization.
Get-MerakiNetworks [-ConfigTemplateId <String>] [-IsBoundToConfigTemplate] [-IncludeTemplates] [<CommonParameters>] Get-MerakiNetworks [-ConfigTemplateId <String>] [-IsBoundToConfigTemplate] [-IncludeTemplates] [-OrgID <String>] [<CommonParameters>] Get-MerakiNetworks [-ConfigTemplateId <String>] [-IsBoundToConfigTemplate] [-IncludeTemplates] [-profileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Get all networks bound to this template Id. | false | false | |||
| SwitchParameter | Get only networks bound to config templates. | false | false | False | ||
| SwitchParameter | Includes a configTemplate property containing the configuration template. | false | false | False | ||
| String | The Organization ID. | false | false | |||
| String | The profile name to use to get networks. | false | false |
The output type is the type of the objects that the cmdlet emits.
Return the traffic analysis data for this network. Traffic analysis with hostname visibility must be enabled on the network.
Get-MerakiNetworkTraffic -Id <String> [-DeviceType <String>] [<CommonParameters>] Get-MerakiNetworkTraffic -Id <String> -StartDate <DateTime> [-DeviceType <String>] [<CommonParameters>] Get-MerakiNetworkTraffic -Id <String> -StartDate <DateTime> [-DeviceType <String>] [<CommonParameters>] Get-MerakiNetworkTraffic -Id <String> -StartDate <DateTime> [-DeviceType <String>] [<CommonParameters>] Get-MerakiNetworkTraffic -Id <String> -Days <Int32> [-DeviceType <String>] [<CommonParameters>] Get-MerakiNetworkTraffic -Id <String> -Days <Int32> [-DeviceType <String>] [<CommonParameters>] Get-MerakiNetworkTraffic -Id <String> -Days <Int32> [-DeviceType <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of the network to retrieve the traffic. | true | true (ByPropertyName) | ||
| StartTime | DateTime | The beginning date/time to retrieve the data. Maximum is 30 days prior to the current date. | true | false | ||
| Int32 | Days prior to the current date to retrieve data. Cannot be more than 30 day prior to the current date. | true | false | 0 | ||
| String | The device type to retrieve the data for. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. | false | false | combined |
Get Meraki Organization
Get-MerakiOrganization [<CommonParameters>] Get-MerakiOrganization [-OrgID <String>] [<CommonParameters>] Get-MerakiOrganization [-profileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The organization ID | false | false | |||
| String | Use the profile name to get organization. | false | false |
The output type is the type of the objects that the cmdlet emits.
Get Organization Admins.
Get-MerakiOrganizationAdmins [<CommonParameters>] Get-MerakiOrganizationAdmins [-OrgID <String>] [<CommonParameters>] Get-MerakiOrganizationAdmins [-profileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Optional Organization Id. | false | false | |||
| String | Optional Profile Name. | false | false |
The output type is the type of the objects that the cmdlet emits.
Returns the Uplink status of Meraki Networks.
Get-MerakiOrganizationApplianceUplinkStatuses [-networkId <String>] [-serial <String>] [<CommonParameters>] Get-MerakiOrganizationApplianceUplinkStatuses [-networkId <String>] [-serial <String>] [-OrgId <String>] [<CommonParameters>] Get-MerakiOrganizationApplianceUplinkStatuses [-networkId <String>] [-serial <String>] [-ProfileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Filters the output by network Id. | false | true (ByValue, ByPropertyName) | * | ||
| String | Filters the output by Appliance serial number. Partial serial number can be specified bu using the * wildcard. i.e. "*HG4U" | false | true (ByValue, ByPropertyName) | * | ||
| String | false | false | ||||
| String | false | false |
The output type is the type of the objects that the cmdlet emits.
Returns VPN statistics for the given organization network.
Get-MerakiOrganizationApplianceVpnStats -id <String> [-perPage <Int32>] [-TimeSpan <Int32>] [-Summarize] [<CommonParameters>] Get-MerakiOrganizationApplianceVpnStats -id <String> [-perPage <Int32>] [-TimeSpan <Int32>] [-Summarize] [-OrgId <String>] [<CommonParameters>] Get-MerakiOrganizationApplianceVpnStats -id <String> [-perPage <Int32>] [-TimeSpan <Int32>] [-Summarize] [-ProfileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Network Id. | true | true (ByValue, ByPropertyName) | |||
| Int32 | The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. | false | false | 100 | ||
| Int32 | Number of seconds to return data for. default = 5. | false | false | 5 | ||
| SwitchParameter | Summarize the statistics, AN array op VPN peer objects or a summary object. |
false | false | False | ||
| String | Optional Organization Id. | false | false | |||
| String | Optional Profile Name | false | false |
List VPN status for networks in an organization
Show VPN status for networks in an organization. can be filtered by Networks.
Get-MerakiOrganizationApplianceVpnStatuses [-id <String>] [-PerPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiOrganizationApplianceVpnStatuses [-id <String>] [-PerPage <Int32>] [-Pages <Int32>] [-OrgId <String>] [<CommonParameters>] Get-MerakiOrganizationApplianceVpnStatuses [-id <String>] [-PerPage <Int32>] [-Pages <Int32>] [-ProfileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The network ID to get VPN status for. | false | true (ByPropertyName) | ||
| Int32 | The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. | false | false | 0 | ||
| Int32 | The number of pages to return. Default is 1, 0 = return all pages. | false | false | 1 | ||
| String | The organization to use. | false | false | |||
| String | The named profile to use. | false | false |
The output type is the type of the objects that the cmdlet emits.
Retrieve a configuration Template
Retrieves the configuration template designated by the provided template Id.
Get-MerakiOrganizationConfigTemplate [-Id <String>] [<CommonParameters>] Get-MerakiOrganizationConfigTemplate [-Id <String>] [-OrgID <String>] [<CommonParameters>] Get-MerakiOrganizationConfigTemplate [-Id <String>] [-profileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| TemplateId | String | The ID of the template to retrieve. | false | true (ByPropertyName) | ||
| String | Optional Organization ID. | false | false | |||
| String | Optional Profile Name | false | false |
The output type is the type of the objects that the cmdlet emits.
Get the Organization Configuration Templates
Get the configuration templates for a given organization.
Get-MerakiOrganizationConfigTemplates [-profileName <String>] [<CommonParameters>] Get-MerakiOrganizationConfigTemplates [-OrgID <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Organization Id. If omitted uses the default profile. | false | false | |||
| String | The profile name to use to get the templates. | false | false |
The output type is the type of the objects that the cmdlet emits.
Get Organization Configuration Changes
Gets configuration changes made to an organization's network.
Get-MerakiOrganizationConfigurationChanges [-PerPage <Int32>] [-Pages <Int32>] [-NetworkID <String>] [-AdminID <String>] [<CommonParameters>] Get-MerakiOrganizationConfigurationChanges [-StartDate <DateTime>] -EndDate <DateTime> [-PerPage <Int32>] [-Pages <Int32>] [-NetworkID <String>] [-AdminID <String>] -ProfileName <String> [<CommonParameters>] Get-MerakiOrganizationConfigurationChanges [-StartDate <DateTime>] -EndDate <DateTime> [-PerPage <Int32>] [-Pages <Int32>] [-NetworkID <String>] [-AdminID <String>] -OrgID <String> [<CommonParameters>] Get-MerakiOrganizationConfigurationChanges [-StartDate <DateTime>] -EndDate <DateTime> [-PerPage <Int32>] [-Pages <Int32>] [-NetworkID <String>] [-AdminID <String>] [<CommonParameters>] Get-MerakiOrganizationConfigurationChanges -Days <Int32> [-PerPage <Int32>] [-Pages <Int32>] [-NetworkID <String>] [-AdminID <String>] -ProfileName <String> [<CommonParameters>] Get-MerakiOrganizationConfigurationChanges -Days <Int32> [-PerPage <Int32>] [-Pages <Int32>] [-NetworkID <String>] [-AdminID <String>] -OrgID <String> [<CommonParameters>] Get-MerakiOrganizationConfigurationChanges -Days <Int32> [-PerPage <Int32>] [-Pages <Int32>] [-NetworkID <String>] [-AdminID <String>] [<CommonParameters>] Get-MerakiOrganizationConfigurationChanges [-PerPage <Int32>] [-Pages <Int32>] [-NetworkID <String>] [-AdminID <String>] -OrgID <String> [<CommonParameters>] Get-MerakiOrganizationConfigurationChanges [-PerPage <Int32>] [-Pages <Int32>] [-NetworkID <String>] [-AdminID <String>] -ProfileName <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| StartTime | DateTime | false | false | |||
| EndTime | DateTime | true | false | |||
| TimeSpan | Int32 | Number of days to pull changes | true | false | 0 | |
| Int32 | Number of records to pull per page. | false | false | 0 | ||
| Int32 | Number of pages to retrieve. 0 = all pages. Default is 1. | false | false | 1 | ||
| String | Filter results by Network ID. | false | false | |||
| String | Filter results by Admin ID. | false | false | |||
| String | Optional Organization Id. | true | false | |||
| String | Optional Profile Name | true | false |
The output type is the type of the objects that the cmdlet emits.
Filter logs for last 10 days by Administrator.
PS> Get-MerakiOrganizationAdmins | Where-Object {$_.Name -eq "John Doe"} | Get-MerakiOrganizationConfigurationChanges -TimeSpan 10
EXAMPLE 2
Filter logs for changes to the Miami network that occurred between 6/1/2020 and 6/30/2020
Get-MerakiNetworks | Where-Object {$_.Name -like "*Miami*"} | Get-MerakiOrganizationConfigurationChanges -StartTime "06/01/2020" -EndTime "06/30/2020"
List the availability information for devices in an organization. The data returned by this endpoint is updated every 5 minutes.
Get-MerakiOrganizationDeviceAvailability [-Filter <String>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiOrganizationDeviceAvailability [-Filter <String>] [-Pages <Int32>] [-OrgId <String>] [<CommonParameters>] Get-MerakiOrganizationDeviceAvailability [-Filter <String>] [-Pages <Int32>] [-ProfileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | A string representing a filter for the returned objects. Valid filter properties are 'usedState', 'search', 'macs', 'networkIds', 'serials', 'models', 'orderNumbers', 'tags', 'tagFilterType', 'productTypes'. All properties are arrays except 'usedState', 'search', and 'tagFilterType'. The search property accepts a single value that will search against serial number, mac address, or model. Valid tagFilterType values are 'withAllTags' or 'withAnyTags'. Valid productTypes values are "appliance","camera","cellularGateway","secureConnect","sensor","switch","systemsManager",or "wireless". |
false | false | |||
| Int32 | NUmber of pages top return. Default is all pages. | false | false | 0 | ||
| String | Organization ID to return devices for. | false | false | |||
| String | Saved profile name. | false | false |
To use the Filter property you must construct a valid filter string. A filter string is like a HTTP query string. To specify a filter string construct it with the property name and values. Array property names must be appended with '[]'. Each member of the array must specify the propertyName[]=value for each member of the array. i.e. "networkIds=N_987654159756&networkId[]=N_159456159753"
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| None | string | false | false | |||
| None | string | false | false | |||
| None | int | false | false | |||
| None | string | false | false |
Get organization Devices.
Get all devices in an organization.
Get-MerakiOrganizationDevices [-Filter <String>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiOrganizationDevices [-Filter <String>] [-Pages <Int32>] [-OrgID <String>] [<CommonParameters>] Get-MerakiOrganizationDevices [-Filter <String>] [-Pages <Int32>] [-profileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | A string representing a filter to be applied to the returned objects. Valid filter properties are 'networkIds', 'productTypes', 'tags', 'tagFilterType', 'name', 'mac', 'serial', 'model', 'macs', 'serials', 'sensorMetrics', 'sensorAlertProfilesIds', 'models'. productTypes, tags, macs, serials, sensorMetrics, sensorAlertProfileIds, and models are arrays. See examples for constructing a filter string. |
false | false | |||
| Int32 | The number of pages to return. Default is all pages. | false | false | 0 | ||
| String | Optional Organization Id.. | false | false | |||
| String | Optional Profile name. | false | false |
The output type is the type of the objects that the cmdlet emits.
To construct a valid filter specify the properties and valued separated by an '='. Each property/value set must be separated by an '&'. Array property names must be appended with '[]'. each member of the array must specify the propertyName[]=value for each member of the array. i.e. "networkIds=N_987654159756&networkId[]=N_159456159753"
List the status of every Meraki device in the organization.
List the status of every Meraki device in the organization. Can be filtered by Network or Serial number.
Get-MerakiOrganizationDeviceStatus [-Filter <String>] [<CommonParameters>] Get-MerakiOrganizationDeviceStatus [-Filter <String>] [-OrgId <String>] [<CommonParameters>] Get-MerakiOrganizationDeviceStatus [-Filter <String>] [-ProfileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | A string representing a filter for the returned objects. Valid filter properties are 'usedState', 'search', 'macs', 'networkIds', 'serials', 'models', 'orderNumbers', 'tags', 'tagFilterType', 'productTypes'. All properties are arrays except 'usedState', 'search', and 'tagFilterType'. The search property accepts a single value that will search against serial number, mac address, or model. Valid tagFilterType values are 'withAllTags' or 'withAnyTags'. Valid productTypes values are "appliance","camera","cellularGateway","secureConnect","sensor","switch","systemsManager",or "wireless". |
false | false | |||
| String | The organization Id to use. | false | false | |||
| String | The named profile to use. | false | false |
The output type is the type of the objects that the cmdlet emits.
To use the Filter property you must construct a valid filter string. A filter string is like a HTTP query string. To specify a filter string construct it with the property name and values. Array values must constructed ny specifying the propertyName[]=value for each member of the array. i.e. "networkIds[]=N_987548754&networkIds[]=N_87589514" Property Names and values are case sensitive.
List the current uplink addresses for devices in an organization.
List the current uplink addresses for devices in an organization. This can be filtered by
Networks, Product Types, Serials, and Tags.
Get-MerakiOrganizationDeviceUplinks [-Filter <String>] [-PerPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiOrganizationDeviceUplinks [-Filter <String>] [-PerPage <Int32>] [-Pages <Int32>] [-OrgId <String>] [<CommonParameters>] Get-MerakiOrganizationDeviceUplinks [-Filter <String>] [-PerPage <Int32>] [-Pages <Int32>] [-ProfileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | A string representing a filter for the returned objects. Valid properties are 'networkIds', 'productTypes', 'serials', 'tags', and 'tagFilterTypes'. All properties except 'tagFilterTypes are arrays. Arrays must be specified in the filter string with '[]' Valid productTypes are "appliance","camera","cellularGateway","secureConnect","sensor","switch","systemsManager", and "wireless". Valid tagFilterTypes as "withAllTags" and "withAnyTag". See Examples for building a filter string. |
false | false | |||
| Int32 | The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000 | false | false | 0 | ||
| Int32 | Number of pages to return. Default is 1, 0 = all pages. | false | false | 0 | ||
| String | Organization Id to use. | false | false | |||
| String | Named profile to use. | false | false |
The output type is the type of the objects that the cmdlet emits.
To use the Filter property you must construct a valid filter string. A filter string is like a HTTP query string. To specify a filter string construct it with the property name and values. Array property names must be appended with '[]'. Each member of the array must specify the propertyName[]=value for each member of the array. i.e. "networkIds=N_987654159756&networkId[]=N_159456159753"
Get firmware upgrade information.
Get firmware upgrade information for an organization
Get-MerakiOrganizationFirmwareUpgrades [-IncludePending] [-includeStarted] [-IncludeCompleted] [-IncludeCanceled] [-IncludeSkipped] [-IncludeAppliances] [-IncludeCameras] [-IncludeCellularGateways] [-IncludeSensors] [-IncludeSwitches] [-IncludeSystemsManagers] [-IncludeWireless] [-PerPage <Int32>] [<CommonParameters>] Get-MerakiOrganizationFirmwareUpgrades [-IncludePending] [-includeStarted] [-IncludeCompleted] [-IncludeCanceled] [-IncludeSkipped] [-IncludeAppliances] [-IncludeCameras] [-IncludeCellularGateways] [-IncludeSensors] [-IncludeSwitches] [-IncludeSystemsManagers] [-IncludeWireless] [-PerPage <Int32>] [-OrgId <String>] [<CommonParameters>] Get-MerakiOrganizationFirmwareUpgrades [-IncludePending] [-includeStarted] [-IncludeCompleted] [-IncludeCanceled] [-IncludeSkipped] [-IncludeAppliances] [-IncludeCameras] [-IncludeCellularGateways] [-IncludeSensors] [-IncludeSwitches] [-IncludeSystemsManagers] [-IncludeWireless] [-PerPage <Int32>] [-ProfileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| SwitchParameter | false | false | False | |||
| SwitchParameter | false | false | False | |||
| SwitchParameter | false | false | False | |||
| SwitchParameter | false | false | False | |||
| SwitchParameter | false | false | False | |||
| SwitchParameter | false | false | False | |||
| SwitchParameter | false | false | False | |||
| SwitchParameter | false | false | False | |||
| SwitchParameter | false | false | False | |||
| SwitchParameter | false | false | False | |||
| SwitchParameter | false | false | False | |||
| SwitchParameter | false | false | False | |||
| Int32 | false | false | 0 | |||
| String | The Organization Id. If omitted the retrieved from the default profile. | false | false | |||
| String | The profile to retrieve the the Organization ID from. | false | false |
Get firmware upgrades by Device
Get Meraki organization firmware upgrades by device
Get-MerakiOrganizationFirmwareUpgradesByDevice [-PerPage <Int32>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiOrganizationFirmwareUpgradesByDevice [-PerPage <Int32>] [-Pages <Int32>] [-OrgId <String>] [<CommonParameters>] Get-MerakiOrganizationFirmwareUpgradesByDevice [-PerPage <Int32>] [-Pages <Int32>] [-ProfileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| Int32 | Number of entries per page. | false | false | 0 | ||
| Int32 | Number of pages to return. Default is all. | false | false | 1 | ||
| String | Optional organization Id | false | false | |||
| String | Optional profile name. | false | false |
The output type is the type of the objects that the cmdlet emits.
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| None | string | false | false | |||
| None | string | true | false | |||
| None | string | false | false |
Get the organization device inventory
Get-MerakiOrganizationInventoryDevices [-Filter <String>] [-Pages <Int32>] [<CommonParameters>] Get-MerakiOrganizationInventoryDevices [-Filter <String>] [-Pages <Int32>] [-OrgID <String>] [<CommonParameters>] Get-MerakiOrganizationInventoryDevices [-Filter <String>] [-Pages <Int32>] [-profileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | A string representing a filter for the returned objects. Valid filter properties are 'usedState', 'search', 'macs', 'networkIds', 'serials', 'models', 'orderNumbers', 'tags', 'tagFilterType', 'productTypes'. All properties are arrays except 'usedState', 'search', and 'tagFilterType'. The search property accepts a single value that will search against serial number, mac address, or model. Valid tagFilterType values are 'withAllTags' or 'withAnyTags'. Valid productTypes values are "appliance","camera","cellularGateway","secureConnect","sensor","switch","systemsManager",or "wireless". Valid usedState values are 'unused', 'used'. |
false | false | |||
| Int32 | false | false | 0 | |||
| String | Organization ID. If omitted used th default profile. | false | false | |||
| String | Profile name to use. If omitted used th default profile. | false | false |
The output type is the type of the objects that the cmdlet emits.
To construct a valid filter specify the properties and valued separated by an '='. Each property/value set must be separated by an '&'. Array property names must be appended with '[]'. Each member of the array must specify the propertyName[]=value for each member of the array. i.e. "networkIds=N_987654159756&networkId[]=N_159456159753"
Get Meraki Organizations
Get all Meraki Organizations your API Key has access to.
Get-MerakiOrganizations [[-APIKey] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Meraki API Key. | false | false |
Returns security event for the organization.
Returns a collection of security event objects for the given organization. Events can be filtered by dates or timespan.
Get-MerakiOrganizationSecurityEvents [-PerPage <Int32>] [-Pages <Int32>] [-Descending] [<CommonParameters>] Get-MerakiOrganizationSecurityEvents -StartDate <DateTime> [-PerPage <Int32>] [-Pages <Int32>] [-Descending] [<CommonParameters>] Get-MerakiOrganizationSecurityEvents -StartDate <DateTime> -EndDate <DateTime> [-PerPage <Int32>] [-Pages <Int32>] [-Descending] -OrgId <String> [<CommonParameters>] Get-MerakiOrganizationSecurityEvents -StartDate <DateTime> -EndDate <DateTime> [-PerPage <Int32>] [-Pages <Int32>] [-Descending] [<CommonParameters>] Get-MerakiOrganizationSecurityEvents -EndDate <DateTime> [-PerPage <Int32>] [-Pages <Int32>] [-Descending] -ProfileName <String> [<CommonParameters>] Get-MerakiOrganizationSecurityEvents -Days <Int32> [-PerPage <Int32>] [-Pages <Int32>] [-Descending] -ProfileName <String> [<CommonParameters>] Get-MerakiOrganizationSecurityEvents -Days <Int32> [-PerPage <Int32>] [-Pages <Int32>] [-Descending] -OrgId <String> [<CommonParameters>] Get-MerakiOrganizationSecurityEvents -Days <Int32> [-PerPage <Int32>] [-Pages <Int32>] [-Descending] [<CommonParameters>] Get-MerakiOrganizationSecurityEvents [-PerPage <Int32>] [-Pages <Int32>] [-Descending] -OrgId <String> [<CommonParameters>] Get-MerakiOrganizationSecurityEvents [-PerPage <Int32>] [-Pages <Int32>] [-Descending] -ProfileName <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| DateTime | The starting date to retrieve data. Cannot be more than 365 days prior to today. | true | false | |||
| DateTime | The ending date to retrieve data. cannot be more than 365 days after StartDate. | true | false | |||
| Int32 | The number if days back from today to retrieve data, Cannot be more than 365. | true | false | 0 | ||
| Int32 | Number of entries per page to retrieve. Acceptable range is 3-1000. Default is 100. NOTE: Paging is not implemented. | false | false | 0 | ||
| Int32 | false | false | 0 | |||
| SwitchParameter | false | false | False | |||
| String | The Organization ID. If omitted and a profile is not specified the default organization is used. Cannot be used with the profile parameter. | true | false | |||
| String | Retrieve the Organization Id from the named profile. Cannot be used with the OrgId parameter | true | false |
The output type is the type of the objects that the cmdlet emits.
Get Organization 3rd party VPNs.
Get-MerakiOrganizationThirdPartyVpnPeers [<CommonParameters>] Get-MerakiOrganizationThirdPartyVpnPeers [-OrgID <String>] [<CommonParameters>] Get-MerakiOrganizationThirdPartyVpnPeers [-profileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Optional Organization Id | false | false | |||
| String | Optional Profile name | false | false |
The output type is the type of the objects that the cmdlet emits.
Returns a Meraki SSID for a network.
Get-MerakiSSID [-Id] <String> [[-Number] <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | true | true (ByPropertyName) | |||
| Int32 | The SSID Number. | false | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Get Meraki switch ACLs
Retrieve Access control LIsts for Meraki Switches
Get-MerakiSwitchAccessControlList [-Id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Network ID | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Return an access policy
Return a specific access policy from a network
Get-MerakiSwitchAccessPolicy [-Id] <String> [[-AccessPolicyNumber] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | true | true (ByPropertyName) | |||
| String | The access policy number to return | false | false |
The output type is the type of the objects that the cmdlet emits.
Return the LAG configurations for a Meraki Network.
Get-MerakiSwitchLAG [-id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The network Id. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns the port configuration for a Meraki switch port.
Get-MerakiSwitchPort [-Serial] <String> [[-PortId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The switch serial number. | true | true (ByPropertyName) | |||
| String | The port Id. If Omitted all ports are returned | false | false |
The output type is the type of the objects that the cmdlet emits.
Retrieve switch port schedules.
Retrieve Meraki switch port schedule for a network.
Get-MerakiSwitchPortSchedules [-Id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | Network ID to retrieve port schedules | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Return the packet counters for all the ports of a switch
Returns packet counter statistics for all ports of a switch.
Get-MerakiSwitchPortsPacketCounters [-serial] <String> [[-Hours] <Decimal>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Serial number of the switch. | true | true (ByPropertyName) | |||
| Decimal | The number of hours to return the data. The default is 24 hours (1 day). Can be entered as a decimal number. For the last 30 minutes enter .5. | false | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Return the status for all the ports of a switch
REturns a collection of switch poe=rt status objects for a switch.
Get-MerakiSwitchPortsStatus [-serial] <String> [[-StartDate] <DateTime>] [[-Days] <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Serial Number of the switch. | true | true (ByPropertyName) | |||
| DateTime | The Starting date to retrieve data. Cannot be more than 31 days prior to today. | false | false | |||
| Int32 | Number of days back from today to retrieve data. Cannot be more than 31 days. | false | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Retrieve Meraki switch QOS rule(s).
Get-MerakiSwitchQosRule [-Id] <String> [[-QosRuleId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | Network ID to retrieve the rules from. | true | true (ByPropertyName) | ||
| String | ID of the QOS rule to retrieve. If omitted all rules are returned | false | false |
The output type is the type of the objects that the cmdlet emits.
Return QOS rules order.
Return the quality of service rule IDs by order in which they will be processed by the switch
Get-MerakiSwitchQosRulesOrder [-NetworkId] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Network Id | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns an interface for a Meraki switch.
Get-MerakiSwitchRoutingInterface [-serial] <String> [[-interfaceId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The serial number of the switch. | true | true (ByPropertyName) | |||
| String | The interface Id. | false | false |
The output type is the type of the objects that the cmdlet emits.
Return DHCP settings for a Meraki switch interface.
Get-MerakiSwitchRoutingInterfaceDHCP [-serial] <String> [-interfaceId] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The serial number of the switch. | true | true (ByPropertyName) | |||
| String | The interface Id. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Retrieve multicast settings for switches
Retrieve the multicast setting for switches in a Meraki network.
Get-MerakiSwitchRoutingMulticast [-Id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | Network ID of the network to retrieve the settings. | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Return routing OSPF setting
Return the Meraki network OSPF settings
Get-MerakiSwitchRoutingOspf [-Id] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of the network | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Retrieve a Static Route(s)
Retrieve a Meraki Switch Static Route
Get-MerakiSwitchRoutingStaticRoute [-Serial] <String> [[-StaticRouteId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The serial number of the switch. | true | true (ByPropertyName) | |||
| String | The ID of the Static Route. If omitted return all static routes. | false | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns a Meraki network switch stack.
Get-MerakiSwitchStack [-Id] <String> [[-StackId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | true | true (ByPropertyName) | |||
| String | The stack Id. | false | false |
The output type is the type of the objects that the cmdlet emits.
Return a Meraki Switch stack routing interface(s).
Get-MerakiSwitchStackRoutingInterface [-NetworkId] <String> [-Id] <String> [[-interfaceId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The network Id. | true | true (ByPropertyName) | |||
| StackId | String | true | true (ByPropertyName) | |||
| String | The interface Id. If Omitted return all interfaces. | false | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns the Meraki switch stack routing interface DHCP setting for an interface.
Get-MerakiSwitchStackRoutingInterfaceDHCP [-interfaceId] <String> [-networkId] <String> [-stackId] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The interface Id. | true | true (ByPropertyName) | |||
| String | The network Id | true | true (ByPropertyName) | |||
| String | The Stack Id. | true | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Retrieves static route(s) from the switch stack.
Get-MerakiSwitchStackRoutingStaticRoute [-NetworkId] <String> [-StackId] <String> [[-StaticRouteId] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network. | true | true (ByPropertyName) | |||
| Id | String | The Id of the switch stack. | true | true (ByPropertyName) | ||
| String | The id of the static route. If Omitted returns all static routes. | false | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Returns Air Marshal scan results from a network.
Get-MerakiWirelessAirMarshal [-Id] <String> [[-Days] <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network. | true | true (ByPropertyName) | |||
| Int32 | Number of days prior to today to return data. | false | false | 0 |
Return PHY data rates over time for a network, device, or network client
Get-MerakiWirelessDataRateHistory -Id <String> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [-ExcludeNoData] [<CommonParameters>] Get-MerakiWirelessDataRateHistory -Id <String> -StartDate <DateTime> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [-ExcludeNoData] [<CommonParameters>] Get-MerakiWirelessDataRateHistory -Id <String> -StartDate <DateTime> -EndDate <DateTime> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [-ExcludeNoData] [<CommonParameters>] Get-MerakiWirelessDataRateHistory -Id <String> -StartDate <DateTime> -EndDate <DateTime> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [-ExcludeNoData] [<CommonParameters>] Get-MerakiWirelessDataRateHistory -Id <String> -EndDate <DateTime> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [-ExcludeNoData] [<CommonParameters>] Get-MerakiWirelessDataRateHistory -Id <String> -Days <Int32> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [-ExcludeNoData] [<CommonParameters>] Get-MerakiWirelessDataRateHistory -Id <String> -Days <Int32> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [-ExcludeNoData] [<CommonParameters>] Get-MerakiWirelessDataRateHistory -Id <String> -Days <Int32> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [-ExcludeNoData] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of the network. | true | true (ByPropertyName) | ||
| DateTime | The starting date to query data. Max 32 days prior to today. | true | false | |||
| DateTime | The ending date to return data. can be a maximum of 31 days after StartDate. | true | false | |||
| Int32 | NUmber of days prior to today to return data. Max 31 days prior to today. | true | false | 0 | ||
| Int32 | The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. | false | false | 0 | ||
| SwitchParameter | Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. | false | false | False | ||
| String | Filter results by network client. | false | false | |||
| DeviceSerial | String | Filter results by device. | false | false | ||
| String | Filter results by AP tag. | false | false | |||
| String | Filter results by band (either '2.4', '5' or '6'). | false | false | |||
| Int32 | Filter results by SSID number. | false | false | 0 | ||
| SwitchParameter | Exclude items that have no data. | false | false | False |
Returns the status of a Meraki Access Point.
Get-MerakiWirelessStatus [-serial] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The serial number of the Access Point. | true | true (ByValue, ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Return Access Point usage over time for a device or network client
Get-MerakiWirelessUsageHistory -Id <String> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [<CommonParameters>] Get-MerakiWirelessUsageHistory -Id <String> -StartDate <DateTime> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [<CommonParameters>] Get-MerakiWirelessUsageHistory -Id <String> -StartDate <DateTime> -EndDate <DateTime> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [<CommonParameters>] Get-MerakiWirelessUsageHistory -Id <String> -StartDate <DateTime> -EndDate <DateTime> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [<CommonParameters>] Get-MerakiWirelessUsageHistory -Id <String> -EndDate <DateTime> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [<CommonParameters>] Get-MerakiWirelessUsageHistory -Id <String> -Days <Int32> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [<CommonParameters>] Get-MerakiWirelessUsageHistory -Id <String> -Days <Int32> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [<CommonParameters>] Get-MerakiWirelessUsageHistory -Id <String> -Days <Int32> [-Resolution <Int32>] [-AutoResolution] [-ClientId <String>] [-Serial <String>] [-APTag <String>] [-Band <String>] [-SsidNumber <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of the network. | true | true (ByPropertyName) | ||
| DateTime | The starting date to query data. Max 32 days prior to today. | true | false | |||
| DateTime | The ending date to return data. can be a maximum of 31 days after StartDate. | true | false | |||
| Int32 | NUmber of days prior to today to return data. Max 31 days prior to today. | true | false | 0 | ||
| Int32 | The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. | false | false | 0 | ||
| SwitchParameter | Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'Resolution' parameter. The default setting is false. | false | false | False | ||
| String | Filter results by network client to return per-device AP usage over time inner joined by the queried client's connection history. | false | true (ByPropertyName) | |||
| DeviceSerial | String | Filter results by device. Requires the Band parameter. | false | true (ByPropertyName) | ||
| String | Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. | false | false | |||
| String | Filter results by band (either '2.4', '5' or '6'). | false | false | |||
| Int32 | Filter results by SSID number. | false | false | 0 |
Combine multiple Meraki networks into a single network.
Merge-MerakiOrganizationNetworks -Name <String> -Id <String> [-EnrollmentString <String>] [-WhatIf] [-Confirm] [<CommonParameters>] Merge-MerakiOrganizationNetworks -Name <String> -Id <String> [-EnrollmentString <String>] [-OrgId <String>] [-WhatIf] [-Confirm] [<CommonParameters>] Merge-MerakiOrganizationNetworks -Name <String> -Id <String> [-EnrollmentString <String>] [-ProfileName <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The name of the combined network. | true | false | |||
| NetworkId | String | The ID of the networks to combine. You should pass an array of network objects to combine those networks. | true | true (ByPropertyName) | ||
| String | A unique identifier which can be used for device enrollment or easy access through the Meraki SM Registration page or the Self Service Portal. Please note that changing this field may cause existing bookmarks to break. All networks that are part of this combined network will have their enrollment string appended by '-network_type'. If left empty, all existing enrollment strings will be deleted. |
false | false | |||
| String | Optional Organization Id | false | false | |||
| String | Optional Profile name. | false | false | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
The output type is the type of the objects that the cmdlet emits.
Create an organization
Create a new Meraki Organization
New-MerakiOrganization [-Name] <String> [[-ManagementName] <String>] [[-ManagementValue] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The name of the organization | true | false | |||
| String | Name of the management system | false | false | |||
| String | Value of the management system | false | false |
Create a new organization third party VPN peer.
New-MerakiOrganizationThirdPartyVpnPeer -Name <String> -Secret <String> [-IkeVersion <String>] [-IpsecPoliciesPreset <String>] [-LocalId <String>] [-PublicIp <String>] -PrivateSubnets <String[]> [-RemoteId <String>] [-NetworkTags <String[]>] [-IpsecPolicies <PSObject>] [<CommonParameters>] New-MerakiOrganizationThirdPartyVpnPeer -Name <String> -Secret <String> [-IkeVersion <String>] [-IpsecPoliciesPreset <String>] [-LocalId <String>] [-PublicIp <String>] -PrivateSubnets <String[]> [-RemoteId <String>] [-NetworkTags <String[]>] [-IpsecPolicies <PSObject>] [-OrgID <String>] [<CommonParameters>] New-MerakiOrganizationThirdPartyVpnPeer -Name <String> -Secret <String> [-IkeVersion <String>] [-IpsecPoliciesPreset <String>] [-LocalId <String>] [-PublicIp <String>] -PrivateSubnets <String[]> [-RemoteId <String>] [-NetworkTags <String[]>] [-IpsecPolicies <PSObject>] [-profileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The name of the VPN peer | true | false | |||
| String | The shared secret with the VPN peer | true | false | |||
| String | The IKE version to be used for the IPsec VPN peer configuration. Defaults to '1' when omitted. Valid values are '1', '2' | false | false | |||
| String | One of the following available presets: 'default', 'aws', 'azure'. If this is provided, the 'ipsecPolicies' parameter is ignored. | false | false | |||
| String | The local ID is used to identify the MX to the peer. This will apply to all MXs this peer applies to. | false | false | |||
| String | The public IP of the VPN peer. | false | false | |||
| String[] | The list of the private subnets of the VPN peer | true | false | |||
| String | The remote ID is used to identify the connecting VPN peer. This can either be a valid IPv4 Address, FQDN or User FQDN. | false | false | |||
| String[] | A list of network tags that will connect with this peer. Use ['all'] for all networks. Use ['none'] for no networks. If not included, the default is ['all']. | false | false | all | ||
| PSObject | Custom IPSec policies for the VPN peer. If not included and a preset has not been chosen, the default preset for IPSec policies will be used. This is ab object with the following properties: childLifetime: integer The lifetime of the Phase 2 SA in seconds. ikeLifetime: integer The lifetime of the Phase 1 SA in seconds. childAuthAlgo: array[] This is the authentication algorithms to be used in Phase 2. The value should be an array with one of the following algorithms: 'sha256', 'sha1', 'md5' childCipherAlgo: array[] This is the cipher algorithms to be used in Phase 2. The value should be an array with one or more of the following algorithms: 'aes256', 'aes192', 'aes128', 'tripledes', 'des', 'null' childPfsGroup: array[] This is the Diffie-Hellman group to be used for Perfect Forward Secrecy in Phase 2. The value should be an array with one of the following values: 'disabled','group14', 'group5', 'group2', 'group1' ikeAuthAlgo: array[] This is the authentication algorithm to be used in Phase 1. The value should be an array with one of the following algorithms: 'sha256', 'sha1', 'md5' ikeCipherAlgo: array[] This is the cipher algorithm to be used in Phase 1. The value should be an array with one of the following algorithms: 'aes256', 'aes192', 'aes128', 'tripledes', 'des' ikeDiffieHellmanGroup: array[] This is the Diffie-Hellman group to be used in Phase 1. The value should be an array with one of the following algorithms: 'group14', 'group5', 'group2', 'group1' ikePrfAlgo: array[] [optional] This is the pseudo-random function to be used in IKE_SA. The value should be an array with one of the following algorithms: 'prfsha256', 'prfsha1', 'prfmd5', 'default'. The 'default' option can be used to default to the Authentication algorithm. |
false | false | |||
| String | Optional Organization Id. | false | false | |||
| String | Optional Profile name. | false | false |
Created a local Secret vault to store secrets.
New-MerakiSecretsVault [[-Authentication] <String>] [[-Interaction] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Specifies how to authenticate access to the SecretStore. The value must be Password or None. If specified as None, the cmdlet enables access to the SecretStore without a password. The default authentication is Password. |
false | false | |||
| String | Specifies whether the SecretStore should prompt a user when they access it. If the value is Prompt, the user is prompted for their password in interactive sessions when required. If the value is None, the user is not prompted for a password. If the value is None and a password is required, the cmdlet requiring the password throws a error. |
false | false |
New-MerakiNetworkSwitchStack
Create a new Switch Stack.
Create a new switch stack in a Meraki network
New-MerakiSwitchStack [-NetworkId] <String> [-Name] <String> [-Serials] <String[]> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network to create the stack in | true | false | |||
| String | The name of the stack | true | false | |||
| String[] | an array of switch serial numbers to add to the stack. | true | false |
The output type is the type of the objects that the cmdlet emits.
Deletes a cellular firewall rule.
Remove-MerakiApplianceCellularFirewallRule [-NetworkId] <String> [-RuleNumber] <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The ID of the network to remove the rule. | true | false | |||
| Int32 | true | false | 0 | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
Remove allowed and blocked URL patterns.
Removes the provided allowed and blocked URL patterns to the content filtering rule.
Remove-MerakiApplianceContentFilteringRules [-id] <String> [[-allowedURLPatterns] <String[]>] [[-blockedURLPatterns] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Network Id. | true | true (ByValue, ByPropertyName) | ||
| String[] | Allowed URL patterns to remove. | false | false | |||
| String[] | Blocked URL patterns to remove. | false | false | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
The output type is the type of the objects that the cmdlet emits.
Remove sites from the allowed and blocked URL patterns. PS> $Network | Remove-MerakiNetworkApplianceContentFilteringRule -allowedUrlPatterns "xtz.com" -blockedUrlPatterns "badsite.com"
Delete a static delegated prefix from a network
Remove-MerakiApplianceDelegatedStaticPrefix [-NetworkId] <String> [-PrefixId] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The ID of te network | true | false | |||
| String | The Prefix Id | true | false | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
The output type is the type of the objects that the cmdlet emits.
Deletes a One To Many firewall NAT rule
Remove-MerakiApplianceFirewallNatRule [-NetworkId] <String> [-Type] <String> [-RuleNumber] <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network. | true | false | |||
| String | true | false | ||||
| Int32 | The rule number to delete | true | false | 0 | ||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
Deleted an inbound cellular firewall rule.
Remove-MerakiApplianceInboundCellularFirewallRule [-NetworkId] <String> [-RuleNumber] <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network. | true | false | |||
| Int32 | The rule number to be removed. | true | false | 0 | ||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
Deletes an inbound firewall rule.
Remove-MerakiApplianceInboundFirewallRule [-NetworkId] <String> [-RuleNumber] <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The ID of the network. | true | false | |||
| Int32 | The rule number to remove. | true | false | 0 | ||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
Delete the specified level 3 firewall rule. (This cannot be undone!)
Remove-MerakiApplianceL3FirewallRule [-NetworkId] <String> [-RuleId] <String> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network. | true | false | |||
| String | The Rule Id to be deleted. | true | false | |||
| SwitchParameter | return the updated rules. | false | false | False | ||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
Deletes an MX L7 firewall rule for an MX network.
Remove-MerakiApplianceL7FirewallRule [-NetworkId] <String> [-RuleNumber] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | true | false | ||||
| String | The rule number to update. | true | false | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
The output type is the type of the objects that the cmdlet emits.
Remove a VLAN
Remove a Meraki Appliance VLAN
Remove-MerakiApplianceVlan [-NetworkId] <String> [-VlanId] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network | true | false | |||
| String | The VLAN ID to remove | true | false | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
Removes a Meraki Network from the Organization. Devices will remain in the Organization's inventory.
This is irreversible, all configuration data and client data will be lost.
Remove-MerakiNetwork [-Id] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Network ID of the network to be deleted. | true | true (ByPropertyName) | ||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| cf | switch | false | false | |||
| NetworkId | string | true | true (ByPropertyName) | |||
| None | string | true | true (ByPropertyName) | |||
| wi | switch | false | false |
Remove a routing interface
Remove a Meraki switch routing interface.
Remove-MerakiSwitchRoutingInterface [-Serial] <String> [-InterfaceId] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Serial number of the switch | true | false | |||
| String | Id of the interface. | true | false | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
The output type is the type of the objects that the cmdlet emits.
Remove a switch stack
Remove a switch stack from a Meraki network
Remove-MerakiSwitchStack [-NetworkId] <String> [-SwitchStackId] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The network ID. | true | false | |||
| String | The switch stack Id. | true | false | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
The output type is the type of the objects that the cmdlet emits.
Remove Meraki switch stack routing interface
Remove an interface from a Meraki switch stack
Remove-MerakiSwitchStackRoutingInterface [-NetworkId] <String> [-StackId] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Network ID of the network containing the switch stack | true | false | |||
| String | The stack ID of the stack to be removed. | true | false | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
The output type is the type of the objects that the cmdlet emits.
Remove a Meraki switch stack static route.
Remove a static route from a Meraki switch stack.
Remove-MerakiSwitchStackRoutingStaticRoute [-NetworkId] <String> [-StackId] <String> [-StaticRouteId] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Network ID of te network containing the switch | true | false | |||
| String | Stack ID to remove the route from. | true | false | |||
| String | Static Route ID to remove. | true | false | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
The output type is the type of the objects that the cmdlet emits.
Remove a switch from a stack
Remove a switch from a Meraki switch stack
Remove-MerakiSwitchStackSwitch [-NetworkId] <String> [-SwitchStackId] <String> [-Serial] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The id o ftghe network | true | false | |||
| String | The ID of the switch stack | true | false | |||
| String | The serial number of the switch to remove. | true | false | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
The output type is the type of the objects that the cmdlet emits.
Remove a static route
Remove a Meraki switch static route
Remove-MerakiSwitchStaticRoute [-Serial] <String> [-StaticRouteId] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The serial number of the switch | true | false | |||
| String | The ID of the static Route | true | false | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
The output type is the type of the objects that the cmdlet emits.
Resets (cycles) a Meraki switch port.
Reset-MerakiSwitchPorts [-serial] <String> [-ports] <String[]> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The switch serial number. | true | true (ByValue, ByPropertyName) | |||
| String[] | An array of port Ids. | true | false |
The output type is the type of the objects that the cmdlet emits.
Restart a Meraki device.
Restart-MerakiDevice [-serial] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The serial number of the device. | true | true (ByValue, ByPropertyName) | |||
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
The output type is the type of the objects that the cmdlet emits.
Set the configuration file.
Sets up the configuration file. This can be the initial configuration or creating named profiles.
Set-MerakiAPI [[-APIKey] <String>] [[-OrgID] <String>] [[-ProfileName] <String>] [-SecureKey] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Your Meraki API key. If a configuration file exists and this key does not match the key in the file a new file will be created overwriting the existing file. |
false | false | |||
| String | The ID of an organization to add to the profile. | false | false | |||
| String | The name of the profile to create. If omitted the OrgID is set as the default profile. | false | false | |||
| SwitchParameter | Save the API key to the a secret Vault. If this parameter is provided alone, your existing API key will be stored in the secret vault and the configuration changed to support the secure key. The config.json file will no longer contain your key in clear text. If you do not have a secrets vault registered you must register on using the New-MerakiSecretsVault function. If your Secrets Management configuration requires a password you will only eed to enter the password when issuing the first command. The vault will remain unlocked for the remainder of the PowerShell session. |
false | false | False |
Create the default profile PS> Set-MerakiAPI -APIKey 'EXAMPLEGDTE63534HD74BD93847' -OrgId 123456EXAMPLE 2
Create a Named Profile. Set-MerakiAPI -OrgId 987458 -ProfileName USNetworkEXAMPLE 3
Create a secure key profile. Set-MerakiAPI -APIKey 'EXAMPLE88fhjryh4666drfe9207' -OrgId 123456 -SecureKeyEXAMPLE 4
Convert your existing configuration to use the Secure Key Store. Set-MerakiAPI -SecureKey
Updates a single cellular firewall rule in the specified network.
Set-MerakiApplianceCellularFirewallRule [-Id] <String> [-RuleNumber] <Int32> [[-Policy] <String>] [[-Protocol] <String>] [[-SourcePort] <String>] [[-SourceCidr] <String>] [[-DestinationCidr] <String>] [[-DestinationPort] <String>] [-SyslogEnabled] [[-Comment] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | false | ||
| Int32 | The RuleNumber to update. | true | false | 0 | ||
| String | 'allow' or 'deny' traffic specified by this rule | false | false | |||
| String | The type of protocol (must be 'tcp', 'udp', 'icmp', 'icmp6' or 'any') | false | false | |||
| srcPort | String | Comma-separated list of source port(s) (integer in the range 1-65535), or 'any' | false | false | ||
| srcCidr | String | Comma-separated list of source IP address(es) (in IP or CIDR notation), or 'any' (note: FQDN not supported for source addresses) | false | false | ||
| DestCidr | String | Comma-separated list of destination IP address(es) (in IP or CIDR notation), fully-qualified domain names (FQDN) or 'any' | false | false | ||
| destPort | String | Comma-separated list of destination port(s) (integer in the range 1-65535), or 'any' | false | false | ||
| SwitchParameter | Log this rule to syslog (true or false, boolean value) - only applicable if a syslog has been configured (optional) | false | false | False | ||
| String | Description of the rule (optional) | false | false |
Update the network's cellular firewall rules
Set-MerakiApplianceCellularFirewallRules [-Id] <String> [-Rules] <PSObject[]> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The network ID to update the rules on. | true | false | ||
| PSObject[] | An array of objects containing the following properties. comment: string Description of the rule (optional) destCidr*: string Comma-separated list of destination IP address(es) (in IP or CIDR notation), fully-qualified domain names (FQDN) or 'any' destPort: string Comma-separated list of destination port(s) (integer in the range 1-65535), or 'any' policy*: string 'allow' or 'deny' traffic specified by this rule protocol*: string The type of protocol (must be 'tcp', 'udp', 'icmp', 'icmp6' or 'any') srcCidr*: string Comma-separated list of source IP address(es) (in IP or CIDR notation), or 'any' (note: FQDN not supported for source addresses) srcPort: string Comma-separated list of source port(s) (integer in the range 1-65535), or 'any' syslogEnabled: boolean Log this rule to syslog (true or false, boolean value) - only applicable if a syslog has been configured (optional) |
true | false |
Update a static delegated prefix from a network.
Set-MerakiApplianceDelegatedStaticPrefix [-Id] <String> [-PrefixId] <String> [[-Description] <String>] [[-Prefix] <String>] [[-Type] <String>] [[-Interfaces] <String[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | true (ByPropertyName) | ||
| String | The Prefix Id. | true | true (ByPropertyName) | |||
| String | false | false | ||||
| String | A static IPv6 prefix | false | false | |||
| String | Type of the origin. Valid values are 'independent', 'internet' | false | false | |||
| String[] | An array of interfaces associated with the prefix. i.e. 'wan1' | false | false |
The output type is the type of the objects that the cmdlet emits.
Add a One to Many NAT mapping rule to an MX network
Set-MerakiApplianceFirewallNatRule [-Id] <String> [-RuleNumber] <Int32> [-Type] <String> [[-PublicIp] <String>] [-Uplink] <String> [-PortRules] <PSObject[]> [[-LanIp] <String>] [[-Name] <String>] [[-AllowedInbound] <PSObject>] [[-Protocol] <String>] [[-PublicPort] <String>] [[-LocalPort] <String>] [[-AllowedIps] <String[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of tye network. | true | false | ||
| Int32 | The rule number oto be updated. | true | false | 0 | ||
| String | The type of rule, can be one of: 'OneToMany','OneToOne',or 'PortForwarding' | true | false | |||
| String | The IP address that will be used to access the internal resource from the WAN. This parameter is only valid for for OneToMany and OneToOne rules. |
false | false | |||
| String | The physical WAN interface on which the traffic will arrive ('internet1' or, if available, 'internet2') | true | false | |||
| PSObject[] | An array of associated forwarding rules with the following properties: localIp: string Local IP address to which traffic will be forwarded localPort: string Destination port of the forwarded traffic that will be sent from the MX to the specified host on the LAN. If you simply wish to forward the traffic without translating the port, this should be the same as the Public port name: string A description of the rule protocol: string 'tcp' or 'udp' publicPort: string Destination port of the traffic that is arriving on the WAN allowedIps: array[] Remote IP addresses or ranges that are permitted to access the internal resource via this port forwarding rule, or 'any' This property can be either a PsObject or a HashTable This property is only valid for OneToMany rules. |
true | false | |||
| String | The IP address of the server or device that hosts the internal resource that you wish to make available on the WAN This parameter is only valid for OneToOne or PortForwarding rules. |
false | false | |||
| String | A descriptive name for the rule. This parameter is only valid for OneToOne or PortForwarding rules. |
false | false | |||
| PSObject | The ports this mapping will provide access on, and the remote IPs that will be allowed access to the resource The parameter is only valid for OneToMany rules. |
false | false | |||
| String | TCP or UDP. Valid values are 'tcp', 'udp' The parameter is only valid for PortForwarding rules. |
false | false | |||
| String | A port or port ranges that will be forwarded to the host on the LAN. The parameter is only valid for PortForwarding rules. |
false | false | |||
| String | A port or port ranges that will receive the forwarded traffic from the WAN The parameter is only valid for PortForwarding rules. |
false | false | |||
| String[] | An array of ranges of WAN IP addresses that are allowed to make inbound connections on the specified ports or port ranges (or any) The parameter is only valid for PortForwarding rules. |
false | false |
The output type is the type of the objects that the cmdlet emits.
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | string | true | true (ByPropertyName) | |||
| None | psobject | true | false | |||
| None | string | true | false |
Updates a single inbound cellular firewall rule in the specified network.
You must get the rule index using the Get-MerakiNetworkApplianceCellularFirewallRule function.
Set-MerakiApplianceInboundCellularFirewallRule [-Id] <String> [-RuleNumber] <Int32> [[-Policy] <String>] [[-Protocol] <String>] [[-SourcePort] <String>] [[-SourceCidr] <String>] [[-DestinationCidr] <String>] [[-DestinationPort] <String>] [-SyslogEnabled] [[-Comment] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | true (ByPropertyName) | ||
| Int32 | true | false | 0 | |||
| String | 'allow' or 'deny' traffic specified by this rule | false | false | |||
| String | The type of protocol (must be 'tcp', 'udp', 'icmp', 'icmp6' or 'any') | false | false | |||
| srcPort | String | Comma-separated list of source port(s) (integer in the range 1-65535), or 'any' | false | false | ||
| srcCidr | String | Comma-separated list of source IP address(es) (in IP or CIDR notation), or 'any' (note: FQDN not supported for source addresses) | false | false | ||
| DestCidr | String | Comma-separated list of destination IP address(es) (in IP or CIDR notation), fully-qualified domain names (FQDN) or 'any' | false | false | ||
| destPort | String | Comma-separated list of destination port(s) (integer in the range 1-65535), or 'any' | false | false | ||
| SwitchParameter | Log this rule to syslog (true or false, boolean value) - only applicable if a syslog has been configured (optional) | false | false | False | ||
| String | Description of the rule (optional) | false | false |
Update the inbound cellular firewall rules of an MX network
Set-MerakiApplianceInboundCellularFirewallRules [-Id] <String> [-Rules] <PSObject[]> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of the network. | true | true (ByPropertyName) | ||
| PSObject[] | An array of inbound cellular firewall rules that include the following properties comment: string Description of the rule (optional) destCidr*: string Comma-separated list of destination IP address(es) (in IP or CIDR notation), fully-qualified domain names (FQDN) or 'any' destPort: string Comma-separated list of destination port(s) (integer in the range 1-65535), or 'any' policy*: string 'allow' or 'deny' traffic specified by this rule protocol*: string The type of protocol (must be 'tcp', 'udp', 'icmp', 'icmp6' or 'any') srcCidr*: string Comma-separated list of source IP address(es) (in IP or CIDR notation), or 'any' (note: FQDN not supported for source addresses) srcPort: string Comma-separated list of source port(s) (integer in the range 1-65535), or 'any' syslogEnabled: boolean Log this rule to syslog (true or false, boolean value) - only applicable if a syslog has been configured (optional) |
true | false |
The output type is the type of the objects that the cmdlet emits.
Updates a single inbound firewall rule in the specified network.
Set-MerakiApplianceInboundFirewallRule [-Id] <String> [-RuleNumber] <Int32> [[-Policy] <String>] [[-Protocol] <String>] [[-SourcePort] <String>] [[-SourceCidr] <String>] [[-DestinationCidr] <String>] [[-DestinationPort] <String>] [-SyslogEnabled] [[-Comment] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | true (ByPropertyName) | ||
| Int32 | The RuleNumber to update. | true | false | 0 | ||
| String | 'allow' or 'deny' traffic specified by this rule | false | false | |||
| String | The type of protocol (must be 'tcp', 'udp', 'icmp', 'icmp6' or 'any') | false | false | |||
| srcPort | String | Comma-separated list of source port(s) (integer in the range 1-65535), or 'any' | false | false | ||
| srcCidr | String | Comma-separated list of source IP address(es) (in IP or CIDR notation), or 'any' (note: FQDN not supported for source addresses) | false | false | ||
| DestCidr | String | Comma-separated list of destination IP address(es) (in IP or CIDR notation), fully-qualified domain names (FQDN) or 'any' | false | false | ||
| destPort | String | Comma-separated list of destination port(s) (integer in the range 1-65535), or 'any' | false | false | ||
| SwitchParameter | Log this rule to syslog (true or false, boolean value) - only applicable if a syslog has been configured (optional) | false | false | False | ||
| String | Description of the rule (optional) | false | false |
Update the inbound firewall rules of an MX network
Set-MerakiApplianceInboundFirewallRules [-Id] <String> [-Rules] <PSObject[]> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The Id of the network. | true | true (ByPropertyName) | ||
| PSObject[] | An array of inbound firewall rules objects. | true | false |
The output type is the type of the objects that the cmdlet emits.
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| None | string | false | false | |||
| None | string | false | false | |||
| None | string | false | false | |||
| None | string | true | false | |||
| None | string | false | false | |||
| None | string | false | false | |||
| None | int | false | false | |||
| None | string | false | false | |||
| None | string | false | false | |||
| None | switch | false | false |
Removes the specified level 3 firewall rules from a network. (This is irreversible!)
Set-MerakiApplianceL3FirewallRules [-Id] <String> [-Rules] <PSObject[]> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | true (ByPropertyName) | ||
| PSObject[] | An array of firewall rules objects. | true | false |
Update an MX L7 firewall rule for an MX network.
Set-MerakiApplianceL7FirewallRule [-Id] <String> [-RuleNumber] <Int32> [[-Type] <String>] [[-Value] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | true (ByPropertyName) | ||
| Int32 | The rule number to update. | true | true (ByPropertyName) | 0 | ||
| String | Type of the L7 rule. One of: 'application', 'applicationCategory', 'host', 'port', 'ipRange' | false | true (ByPropertyName) | |||
| String | The 'value' of what you want to block. Format of 'value' varies depending on type of the rule. The application categories and application ids can be retrieved from the the 'Get-MerakiNetworkApplianceApplicationCategories' endpoint. The countries follow the two-letter ISO 3166-1 alpha-2 format |
false | true (ByPropertyName) |
The output type is the type of the objects that the cmdlet emits.
Update the MX L7 firewall rules for an MX network
Set-MerakiApplianceL7FirewallRules [-Id] <String> [[-Rules] <PSObject[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| NetworkId | String | The ID of the network. | true | true (ByPropertyName) | ||
| PSObject[] | An array of level 7 firewall rules. | false | false |
The output type is the type of the objects that the cmdlet emits.
Update the per-port VLAN settings for a single MX port.
Set-MerakiAppliancePort [-NetworkId] <String> [-Number] <String> [[-VlanId] <Int32>] [-Type] <String> [[-AccessPolicy] <String>] [[-AllowedVLANS] <String>] [-DropUntaggedTraffic] [-Enabled] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| Id | String | The Id of the network | true | true (ByPropertyName) | ||
| String | The port number to be updated. | true | true (ByPropertyName) | |||
| Int32 | Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode. | false | false | 0 | ||
| String | The type of the port: 'access' or 'trunk'. | true | false | |||
| String | The name of the policy. Only applicable to Access ports. Valid values are: 'open', '8021x-radius', 'mac-radius', 'hybris-radius' for MX64 or Z3 or any MX supporting the per port authentication feature. Otherwise, 'open' is the only valid value and 'open' is the default value if the field is missing. | false | false | |||
| String | Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port. | false | false | |||
| SwitchParameter | Trunk port can Drop all Untagged traffic. When true, no VLAN is required. Access ports cannot have dropUntaggedTraffic set to true. | false | false | False | ||
| SwitchParameter | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Return single LAN configuration
Set-MerakiApplianceSingleLan -NetworkId <String> [-ApplianceIp <String>] [-subnet <String>] [-MandatoryDHCP] [<CommonParameters>] Set-MerakiApplianceSingleLan -NetworkId <String> [-ApplianceIp <String>] [-subnet <String>] [-Ipv6Enabled] [-Ipv6PrefixAssignments <PSObject[]>] [-MandatoryDHCP] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the Network. | true | false | |||
| String | The local IP of the appliance on the single LAN | false | false | |||
| String | The subnet of the single LAN | false | false | |||
| SwitchParameter | Enable IPv6 on single LAN | false | false | False | ||
| PSObject[] | An array of Ipv6 prefix assignments on the single LAN. | false | false | |||
| SwitchParameter | Mandatory DHCP will enforce that clients connecting to this single LAN must use the IP address assigned by the DHCP server. Clients who use a static IP address won't be able to associate. | false | false | False |
Update Network Site-to-Site VPN
Update the Meraki Network Site to Site VPN Settings.
Set-MerakiApplianceSiteToSiteVpn [-NetworkId] <String> [-Mode] <String> [[-Hubs] <PSObject[]>] [[-Subnets] <PSObject[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The ID of the to update | true | false | |||
| String | The site-to-site VPN mode. Can be one of 'none', 'spoke' or 'hub' | true | true (ByPropertyName) | |||
| PSObject[] | The list of VPN hubs, in order of preference. In spoke mode, at least 1 hub is required. Hub objects contain the following properties. hubId:string (Required) - The network ID of the hub. useDefaultRoute:boolean - Only valid in 'spoke' mode. Indicates whether default route traffic should be sent to this hub. |
false | true (ByPropertyName) | |||
| PSObject[] | The list of subnets and their VPN presence. Subnet object contain the following properties: localSubnet:string (required) - The CIDR notation subnet used within the VPN useVpn: boolean - Indicates the presence of the subnet in the VPN |
false | true (ByPropertyName) |
Updating an existing network configured as a spoke. # The easiest way to do this is to get the current von settings in an object. $VpnSettings = Get-MerakiNetworkApplianceSiteToSiteCpn -id N_1246598574 # Modify the settings in this object # Set the 1st hub destination $VpnSettings.hubs[0].hubId = N_5452659857 $VpnSettings.hubs[0].useDefaultRoute = $false # Modify the 2nd hub destination $VpnSettings.hubs[0].hubId = N_4585965254 $VpnSettings.hubs[0].useDefaultRoute = $false # Modify the subnet settings if necessary $VpnSettings.Subnets[0].localSubnet = 10.5.5.5/24 $VpnSettings.Subnets[0].useVpn = $true # Update the VPN Settings Set-MerakiNetworkApplianceSiteToSiteVpn -NetworkId N_1246598574 -VpnSettings $VpnSettingsEXAMPLE 2
In this example we are going to convert a Hub (mess) network to a Spoke network In this instance the subnet is already set as we want it so we will only change the mode and add in the remote hub networks.
Update a static route for an MX or teleworker network.
Set-MerakiApplianceStaticRoute [-NetworkId] <String> [-Id] <String> [[-Name] <String>] [-Disable] [[-Subnet] <String>] [[-NextHopIp] <String>] [[-NextHopVlanID] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The ID of the network | true | true (ByPropertyName) | |||
| RouteId | String | The Id of the static route. | true | true (ByPropertyName) | ||
| String | The name of the static route. | false | false | |||
| SwitchParameter | Disable the static route. Omitting this parameter will enable the static route. | false | false | False | ||
| String | The subnet of the static route | false | false | |||
| GatewayIp | String | The next hop IP of the static route. | false | false | ||
| GatewayVlanID | String | The next hop IP VLAN ID of the static route. | false | false |
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| None | string | false | false | |||
| None | string | false | false | |||
| None | string | false | false | |||
| None | string | false | false | |||
| None | bool | false | false | |||
| None | string | false | false | |||
| None | string | false | false | |||
| None | hashtable[] | false | false | |||
| None | string[] | false | false | |||
| None | string | false | false | |||
| None | string | false | false | |||
| None | hashtable[] | false | false | |||
| None | switch | false | false | |||
| None | bool | false | false | |||
| None | string | false | false | |||
| None | string | true | true (ByPropertyName) | |||
| None | hashtable[] | false | false | |||
| None | string | false | false | |||
| None | string | false | false | |||
| id | string | true | true (ByPropertyName) | |||
| None | string | false | false | |||
| None | string | false | false | |||
| None | hashtable[] | false | false |
Update the attributes of a Device.
Set-MerakiDevice [-Serial] <String> [[-Name] <String>] [[-floorPlanId] <String>] [[-Notes] <String>] [[-SwitchProfileId] <String>] [-MoveMapMaker] [[-Latitude] <Int32>] [[-Longitude] <Int32>] [[-Tags] <String[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The serial number of the device. | true | true (ByPropertyName) | |||
| String | The name of the device. | false | false | |||
| String | The floor plan to associate to this device. null disassociates the device from the floorplan. | false | false | |||
| String | The notes for the device. String. Limited to 255 characters. | false | false | |||
| String | The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template. | false | false | |||
| SwitchParameter | Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified. | false | false | False | ||
| Int32 | The latitude of a device | false | false | 0 | ||
| Int32 | The longitude of a device | false | false | 0 | ||
| String[] | An array of tags of a device | false | false |
The output type is the type of the objects that the cmdlet emits.
Modify a network
Modify settings on a Meraki Network
Set-MerakiNetwork [-NetworkId] <String> [-Name] <String> [[-TimeZone] <String>] [[-Notes] <String>] [[-Tags] <String[]>] [[-EnrollmentString] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The ID of the network | true | false | |||
| String | The name of the network | true | false | |||
| String | The timezone of the network. For a list of allowed timezones | false | false | |||
| String | Add any notes or additional information about this network here | false | false | |||
| String[] | A list of tags to be applied to the network | false | false | |||
| String | A unique identifier which can be used for device enrollment or easy access through the Meraki SM Registration page or the Self Service Portal. Please note that changing this field may cause existing bookmarks to break. |
false | false |
The output type is the type of the objects that the cmdlet emits.
Update an organization
Update a Meraki Organization
Set-MerakiOrganization -Name <String> [-ManagementName <String>] [-ManagementValue <String>] [-ApiEnabled] [<CommonParameters>] Set-MerakiOrganization -Name <String> [-ManagementName <String>] [-ManagementValue <String>] [-ApiEnabled] [-OrgID <String>] [<CommonParameters>] Set-MerakiOrganization -Name <String> [-ManagementName <String>] [-ManagementValue <String>] [-ApiEnabled] [-profileName <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The name of the organization | true | false | |||
| String | Name of the management data | false | false | |||
| String | Value of the management data | false | false | |||
| SwitchParameter | If present, enable the access to the Cisco Meraki Dashboard API | false | false | False | ||
| String | The organization Id | false | false | |||
| String | The saved profile name | false | false |
The output type is the type of the objects that the cmdlet emits.
Set the default profile to the specified named profile.
Use this function to set the default profile for all subsequent command.
This changes the organization ID of the default profile so any future commands will use this profile even after closing out of PowerShell.
Set-MerakiProfile [-profileName] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The name of the profile to use. | true | false |
Set Meraki Switch Interface.
Set a Meraki switch routing interface.
Set-MerakiSwitchRoutingInterface [-Serial] <String> [-InterfaceId] <String> [[-VlanId] <Int32>] [[-Name] <String>] [[-Subnet] <String>] [[-DefaultGateway] <String>] [[-InterfaceIp] <String>] [[-MulticastRouting] <String>] [[-Ipv6Address] <String>] [[-Ipv6AssignmentMode] <String>] [[-Ipv6Gateway] <String>] [[-Ipv6Prefix] <String>] [[-OspfCost] <Int32>] [[-OspfArea] <String>] [-OspfIsPassive] [[-OspfV3Cost] <Int32>] [[-OspfV3Area] <String>] [-OspfV3IsPassive] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Switch serial number. | true | false | |||
| String | Interface ID to be updates. | true | false | |||
| Int32 | The VLAN this routed interface is on. VLAN must be between 1 and 4094. | false | false | 0 | ||
| String | A friendly name or description for the interface or VLAN. | false | false | |||
| String | The network that this routed interface is on, in CIDR notation (ex. 10.1.1.0/24). | false | false | |||
| String | The next hop for any traffic that isn't going to a directly connected subnet or over a static route. This IP address must exist in a subnet with a routed interface. Required if this is the first IPv4 interface. |
false | false | |||
| String | The IP address this switch will use for layer 3 routing on this VLAN or subnet. This cannot be the same as the switch's management IP. | false | false | |||
| String | Enable multicast support if, multicast routing between VLANs is required. Options are: 'disabled', 'enabled' or 'IGMP snooping querier'. Default is 'disabled'. |
false | false | |||
| String | The IPv6 address of the interface. Required if assignmentMode is 'static'. Must not be included if assignmentMode is 'eui-64'. | false | false | |||
| String | The IPv6 assignment mode for the interface. Can be either 'eui-64' or 'static'. | false | false | |||
| String | The IPv6 default gateway of the interface. Required if prefix is defined and this is the first interface with IPv6 configured for the switch. | false | false | |||
| String | The IPv6 prefix of the interface. Required if IPv6 object is included. | false | false | |||
| Int32 | The path cost for this interface. Defaults to 1, but can be increased up to 65535 to give lower priority. | false | false | 0 | ||
| String | The OSPF area to which this interface should belong. Can be either 'disabled' or the identifier of an existing OSPF area. Defaults to 'disabled'. | false | false | |||
| SwitchParameter | When enabled, OSPF will not run on the interface, but the subnet will still be advertised. | false | false | False | ||
| Int32 | The path cost for this interface. Defaults to 1, but can be increased up to 65535 to give lower priority. | false | false | 0 | ||
| String | The OSPFv3 area to which this interface should belong. Can be either 'disabled' or the identifier of an existing OSPFv3 area. Defaults to 'disabled'. | false | false | |||
| SwitchParameter | When enabled, OSPFv3 will not run on the interface, but the subnet will still be advertised. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Update Meraki switch routing interface DHCP Settings
Add or update the Meraki switch routing interface DHCP settings.
Use this method to configure DHCP setting for a new interface.
Set-MerakiSwitchRoutingInterfaceDhcp -Serial <String> -InterfaceId <String> [-DhcpMode <String>] [-DhcpRelayServerIps <String[]>] [-DhcpLeaseTime <String>] [-DnsNameServerOptions <String>] [-DnsCustomNameServers <String[]>] [-DhcpOptions <Hashtable[]>] [-ReservedIpRanges <Hashtable[]>] [-FixedIpRanges <Hashtable[]>] [<CommonParameters>] Set-MerakiSwitchRoutingInterfaceDhcp -Serial <String> -InterfaceId <String> [-DhcpMode <String>] [-DhcpRelayServerIps <String[]>] [-DhcpLeaseTime <String>] [-DnsNameServerOptions <String>] [-DnsCustomNameServers <String[]>] [-BootOptionsEnabled] [-BootNextServer <String>] [-BootFileName <String>] [-DhcpOptions <Hashtable[]>] [-ReservedIpRanges <Hashtable[]>] [-FixedIpRanges <Hashtable[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Device serial number | true | true (ByPropertyName) | |||
| String | Interface Id of the interface to be updated. | true | true (ByPropertyName) | |||
| String | The DHCP mode options for the switch interface ('dhcpDisabled', 'dhcpRelay' or 'dhcpServer') | false | false | |||
| String[] | The DHCP relay server IPs to which DHCP packets would get relayed for the switch interface | false | false | |||
| String | The DHCP lease time config for the dhcp server running on switch interface ('30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week') |
false | false | |||
| String | The DHCP name server option for the dhcp server running on the switch interface ('googlePublicDns', 'openDns' or 'custom') | false | false | |||
| String[] | The DHCP name server IPs when DHCP name server option is 'custom' | false | false | |||
| SwitchParameter | Enable DHCP boot options to provide PXE boot options configs for the dhcp server running on the switch interface | false | false | False | ||
| String | The PXE boot server IP for the DHCP server running on the switch interface | false | false | |||
| String | The PXE boot server filename for the DHCP server running on the switch interface | false | false | |||
| Hashtable[] | Array of DHCP options consisting of code, type and value for the DHCP server running on the switch interface DHCP option objects consist of the following fields. code:string - The code for DHCP option which should be from 2 to 254 type:string - The type of the DHCP option which should be one of ('text', 'ip', 'integer' or 'hex') value:string - The value of the DHCP option |
false | false | |||
| Hashtable[] | Array of DHCP reserved IP assignments for the DHCP server running on the switch interface Reserved Ip Range objects consist of the following fields comment:string - The comment for the reserved IP range end:string - The ending IP address of the reserved IP range start:string - The starting IP address of the reserved IP range |
false | false | |||
| Hashtable[] | Array of DHCP fixed IP assignments for the DHCP server running on the switch interface Fixed Ip Range objects consist of the following fields. ip*:string - The IP address of the client which has fixed IP address assigned to it mac*: string - The MAC address of the client which has fixed IP address name*: string - The name of the client which has fixed IP address |
false | false |
Update a static route
Update a Meraki switch static route
Set-MerakiSwitchRoutingStaticRoute [-Serial] <String> [-StaticRouteId] <String> [[-Name] <String>] [[-NextHopIp] <String>] [[-Subnet] <String>] [-AdvertiseViaOspfEnabled] [-PreferOverOspfRoutesEnabled] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Serial number of the switch | true | false | |||
| String | The statis route Id | true | false | |||
| String | Name or description for layer 3 static route | false | false | |||
| String | IP address of the next hop device to which the device sends its traffic for the subnet | false | false | |||
| String | The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24) | false | false | |||
| SwitchParameter | Option to advertise static route via OSPF | false | false | False | ||
| SwitchParameter | Option to prefer static route over OSPF routes. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Update a switch stack routing interface.
Set-MerakiSwitchStackRoutingInterface [-NetworkId] <String> [-StackId] <String> [-InterfaceId] <String> [-VlanId] <Int32> [-Name] <String> [[-Subnet] <String>] [[-InterfaceIp] <String>] [[-DefaultGateway] <String>] [[-Ipv6Address] <String>] [[-Ipv6AssignmentMode] <String>] [[-Ipv6Gateway] <String>] [[-Ipv6Prefix] <String>] [[-OspfCost] <Int32>] [[-OspfArea] <String>] [[-OspfIsPassiveEnabled] <Boolean>] [[-OspfV3Cost] <Int32>] [[-OspfV3Area] <String>] [[-OspfV3IsPassiveEnabled] <Boolean>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The network Id. | true | false | |||
| String | The stack Id. | true | false | |||
| String | The Interface Id. | true | false | |||
| Int32 | The VLAN this routed interface is on. VLAN must be between 1 and 4094 | true | false | 0 | ||
| String | A friendly name or description for the interface or VLAN. | true | false | |||
| String | The network that this routed interface is on, in CIDR notation (ex. 10.1.1.0/24). | false | false | |||
| String | The IP address this switch stack will use for layer 3 routing on this VLAN or subnet. This cannot be the same as the switch's management IP. | false | false | |||
| String | The next hop for any traffic that isn't going to a directly connected subnet or over a static route. This IP address must exist in a subnet with a routed interface. | false | false | |||
| String | The IPv6 address of the interface. Required if assignmentMode is 'static'. Must not be included if assignmentMode is 'eui-64'. | false | false | |||
| String | The IPv6 assignment mode for the interface. Can be either 'eui-64' or 'static'. | false | false | |||
| String | The IPv6 default gateway of the interface. Required if prefix is defined and this is the first interface with IPv6 configured for the stack. | false | false | |||
| String | The IPv6 prefix of the interface. Required if IPv6 object is included. | false | false | |||
| Int32 | The path cost for this interface. Defaults to 1, but can be increased up to 65535 to give lower priority. | false | false | 0 | ||
| String | The OSPF area to which this interface should belong. Can be either 'disabled' or the identifier of an existing OSPF area. Defaults to 'disabled'. | false | false | |||
| Boolean | When enabled, OSPF will not run on the interface, but the subnet will still be advertised. | false | false | False | ||
| Int32 | The path cost for this interface. Defaults to 1, but can be increased up to 65535 to give lower priority. | false | false | 0 | ||
| String | The OSPF area to which this interface should belong. Can be either 'disabled' or the identifier of an existing OSPF area. Defaults to 'disabled'. | false | false | |||
| Boolean | When enabled, OSPF will not run on the interface, but the subnet will still be advertised. | false | false | False |
Update a switch stack interface DHCP settings
Set-MerakiSwitchStackRoutingInterfaceDhcp [-NetworkId] <String> [-StackId] <String> [-interfaceId] <String> [[-DhcpMode] <String>] [[-DhcpLeaseTime] <String>] [[-DnsNameServerOption] <String>] [[-DnsCustomNameServers] <String[]>] [-BootOptionsEnabled] [[-BootNextServer] <String>] [[-BootFilename] <String>] [[-DhcpOptions] <Hashtable>] [[-ReservedIpRanges] <Hashtable[]>] [[-fixedIpAssignments] <Hashtable[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The ID of the network | true | false | |||
| String | The Od os the stack. | true | false | |||
| String | The Id of the interface. | true | false | |||
| String | The DHCP mode options for the switch stack interface ('dhcpDisabled', 'dhcpRelay' or 'dhcpServer') | false | false | |||
| String | The DHCP lease time config for the dhcp server running on switch stack interface ('30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week') | false | false | |||
| String | The DHCP name server option for the dhcp server running on the switch stack interface. ('googlePublicDns', 'openDns' or 'custom') | false | false | |||
| String[] | The DHCP name server IPs when DHCP name server option is 'custom'. | false | false | |||
| SwitchParameter | Enable DHCP boot options to provide PXE boot options configs for the dhcp server running on the switch stack interface. | false | false | False | ||
| String | The PXE boot server IP for the DHCP server running on the switch stack interface | false | false | |||
| String | The PXE boot server file name for the DHCP server running on the switch stack interface | false | false | |||
| Hashtable | Array of DHCP options (hash table) consisting of code, type and value for the DHCP server running on the switch stack interface. code: string The code for DHCP option which should be from 2 to 254 type: string The type of the DHCP option which should be one of ('text', 'ip', 'integer' or 'hex') value: string The value of the DHCP option |
false | false | |||
| Hashtable[] | Array of DHCP reserved IP assignments (hash table) for the DHCP server running on the switch stack interface comment: string The comment for the reserved IP range end: string The ending IP address of the reserved IP range start: string The starting IP address of the reserved IP range |
false | false | |||
| Hashtable[] | Array of DHCP fixed IP assignments (hashtable) for the DHCP server running on the switch stack interface. ip: string The IP address of the client which has fixed IP address assigned to it mac: string The MAC address of the client which has fixed IP address name: string The name of the client which has fixed IP address |
false | false |
Retrieves a static route for the specified network.
Set-MerakiSwitchStackRoutingStaticRoute [-NetworkId] <String> [-StackId] <String> [-StaticRouteId] <String> [[-Name] <String>] [[-NextHopIp] <String>] [[-Subnet] <String>] [-AdvertiseViaOspf] [-PreferOverOspfRoutes] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Id of the network | true | false | |||
| String | The Id of the stack. | true | false | |||
| String | The Id of the static route. | true | false | |||
| String | Name od the static route. | false | false | |||
| String | IP address of the next hop device to which the device sends its traffic for the subnet | false | false | |||
| String | The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24) | false | false | |||
| SwitchParameter | Option to advertise static route via OSPF | false | false | False | ||
| SwitchParameter | Option to prefer static route over OSPF routes | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Starts the LED blinking on a Meraki Device.
Start-MerakiDeviceBlink [-serial] <String> [[-Duration] <Int32>] [[-Duty] <Int32>] [[-Period] <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Serial number of the device. | true | true (ByValue, ByPropertyName) | |||
| Int32 | Duration ios seconds to blink. Default = 20 | false | false | 0 | ||
| Int32 | The duty cycle as percent active. Default = 50 | false | false | 0 | ||
| Int32 | false | false | 0 |
Update the content filtering rules.
Update-MerakiApplianceContentFiltering -id <String> [-urlCategoryListSize <String>] [<CommonParameters>] Update-MerakiApplianceContentFiltering -id <String> [-allowedURLPatterns <String[]>] [-blockedURLPatterns <String[]>] [-blockedUrlCategories <String[]>] [-urlCategoryListSize <String>] [<CommonParameters>] Update-MerakiApplianceContentFiltering -id <String> [-urlCategoryListSize <String>] [-ContentFilteringRules <PSObject>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Network Id. | true | true (ByValue, ByPropertyName) | |||
| String[] | An array of allowed URL patterns. | false | false | |||
| String[] | AM array of blocked URL patterns. | false | false | |||
| String[] | An array of blocked URL Categories. | false | false | |||
| String | The list size of the category list. Note this parameter is not supported on MX100 and above devices. | false | false | |||
| PSObject | A Meraki content filtering rule object (not supported with other parameters). | false | false |
The output type is the type of the objects that the cmdlet emits.
You must pull the Content Filtering Rules using the function Get-MerakiNetworkApplianceContentFiltering and then modify the properties of that object.
Adding a new URL to the blocked URL Pattern
PS> $cfr = Get-MerakiNetworks | Where-Object {$_.Name -like "Dallas} | Get-MerakiNetworkApplianceContentFiltering
PS> $cfr.blockedUrlPatterns += "example.com"
PS> Get-MerakiNetworks | Where-Object {$_.Name -like "Dallas"} | Update-MerakiNetworkApplianceContentFiltering -allowedUrlPatterns $cfr.allowedUrlPattern -blockedUrlPatterns $cfr.blockedUrlPatterns -blockedUrlCategories $cfr.blockedUrlCategories -urlCategoryListSize $cfr.urlCategoryListSize
or
PS > Get-MerakiNetworks | Where-Object {$_.like "Dallas"} | Update-MerakiNetworkApplianceContentFiltering -ContentFilteringRules $cfr
EXAMPLE 2
Updating Templates
If you have networks bound to templates, you should must the template and allow the template to trickle the changes down to the bound network.
PS> $cfr = Get-MerakiOrganizationConfigTemplates | Where-object {$_.Name -eq "Org-Template"} | Get-MerakiNetworkApplianceContentFiltering
PS> $cfr.clockedUrlPatterns += "example.com"
PS> Get-MerakiOrganizationConfigTemplates | Where-Object ($_.Name -eq "Org-Template"} Update-MerakiNetworkApplianceContentFiltering -ContentFilteringRules $cfr