@datafire/meraki

v3.0.0

Published

3 years ago

DataFire integration for Meraki Dashboard API

Downloads

0High
0Medium
0Low

datafire

@datafire/meraki

Client library for Meraki Dashboard API

Installation and Usage

npm install --save @datafire/meraki

let meraki = require('@datafire/meraki').create({
  meraki_api_key: ""
});

.then(data => {
  console.log(data);
});

Description

The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.

Date: 02 December, 2020
What's New

API Documentation

Community Support

Meraki Homepage

Actions

getDevice

Return a single device

meraki.getDevice({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

updateDevice

Update the attributes of a device

meraki.updateDevice({
  "serial": ""
}, context)

Input

input object
- serial required string
- updateDevice object
  - address string: The address of a device
  - floorPlanId string: The floor plan to associate to this device. null disassociates the device from the floorplan.
  - lat number: The latitude of a device
  - lng number: The longitude of a device
  - moveMapMarker boolean: 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.
  - name string: The name of a device
  - notes string: The notes for the device. String. Limited to 255 characters.
  - switchProfileId string: The ID of a switch profile to bind to the device (for available switch profiles, see the 'Switch Profiles' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch profile, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
  - tags array: The list of tags of a device
    - items string

Output

output object

getDeviceApplianceDhcpSubnets

Return the DHCP subnet information for an appliance

meraki.getDeviceApplianceDhcpSubnets({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

getDeviceAppliancePerformance

Return the performance score for a single MX. Only primary MX devices supported. If no data is available, a 204 error code is returned.

meraki.getDeviceAppliancePerformance({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

blinkDeviceLeds

Blink the LEDs on a device

meraki.blinkDeviceLeds({
  "serial": ""
}, context)

Input

input object
- serial required string
- blinkDeviceLeds object
  - duration integer: The duration in seconds. Must be between 5 and 120. Default is 20 seconds
  - duty integer: The duty cycle as the percent active. Must be between 10 and 90. Default is 50.
  - period integer: The period in milliseconds. Must be between 100 and 1000. Default is 160 milliseconds

Output

output object

getDeviceCameraAnalyticsLive

Returns live state from camera of analytics zones

meraki.getDeviceCameraAnalyticsLive({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

getDeviceCameraAnalyticsOverview

Returns an overview of aggregate analytics data for a timespan

meraki.getDeviceCameraAnalyticsOverview({
  "serial": ""
}, context)

Input

input object
- serial required string
- t0 string: The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
- t1 string: The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
- timespan number: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. The default is 1 hour.
- objectType string (values: person, vehicle): [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle].

Output

output object

getDeviceCameraAnalyticsRecent

Returns most recent record for analytics zones

meraki.getDeviceCameraAnalyticsRecent({
  "serial": ""
}, context)

Input

input object
- serial required string
- objectType string (values: person, vehicle): [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle].

Output

output object

getDeviceCameraAnalyticsZones

Returns all configured analytic zones for this camera

meraki.getDeviceCameraAnalyticsZones({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

getDeviceCameraAnalyticsZoneHistory

Return historical records for analytic zones

meraki.getDeviceCameraAnalyticsZoneHistory({
  "serial": "",
  "zoneId": ""
}, context)

Input

input object
- serial required string
- zoneId required string
- t0 string: The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
- t1 string: The end of the timespan for the data. t1 can be a maximum of 14 hours after t0.
- timespan number: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 14 hours. The default is 1 hour.
- resolution integer: The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60.
- objectType string (values: person, vehicle): [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle].

Output

output object

generateDeviceCameraSnapshot

Generate a snapshot of what the camera sees at the specified time and return a link to that image.

meraki.generateDeviceCameraSnapshot({
  "serial": ""
}, context)

Input

input object
- serial required string
- generateDeviceCameraSnapshot object
  - fullframe boolean: [optional] If set to "true" the snapshot will be taken at full sensor resolution. This will error if used with timestamp.
  - timestamp string: [optional] The snapshot will be taken from this time on the camera. The timestamp is expected to be in ISO 8601 format. If no timestamp is specified, we will assume current time.

Output

output object

getDeviceCameraQualityAndRetention

Returns quality and retention settings for the given camera

meraki.getDeviceCameraQualityAndRetention({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

updateDeviceCameraQualityAndRetention

Update quality and retention settings for the given camera

meraki.updateDeviceCameraQualityAndRetention({
  "serial": ""
}, context)

Input

input object
- serial required string
- updateDeviceCameraQualityAndRetention object
  - audioRecordingEnabled boolean: Boolean indicating if audio recording is enabled(true) or disabled(false) on the camera
  - motionBasedRetentionEnabled boolean: Boolean indicating if motion-based retention is enabled(true) or disabled(false) on the camera
  - motionDetectorVersion integer (values: 1, 2): The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2.
  - profileId string: The ID of a quality and retention profile to assign to the camera. The profile's settings will override all of the per-camera quality and retention settings. If the value of this parameter is null, any existing profile will be unassigned from the camera.
  - quality string (values: Standard, High, Enhanced): Quality of the camera. Can be one of 'Standard', 'High' or 'Enhanced'. Not all qualities are supported by every camera model.
  - resolution string (values: 1280x720, 1920x1080, 1080x1080, 2058x2058): Resolution of the camera. Can be one of '1280x720', '1920x1080', '1080x1080' or '2058x2058'. Not all resolutions are supported by every camera model.
  - restrictedBandwidthModeEnabled boolean: Boolean indicating if restricted bandwidth is enabled(true) or disabled(false) on the camera

Output

output object

getDeviceCameraSense

Returns sense settings for a given camera

meraki.getDeviceCameraSense({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

updateDeviceCameraSense

Update sense settings for the given camera

meraki.updateDeviceCameraSense({
  "serial": ""
}, context)

Input

input object
- serial required string
- updateDeviceCameraSense object
  - detectionModelId string: The ID of the object detection model
  - mqttBrokerId string: The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
  - senseEnabled boolean: Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera

Output

output object

getDeviceCameraSenseObjectDetectionModels

Returns the MV Sense object detection model list for the given camera

meraki.getDeviceCameraSenseObjectDetectionModels({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

getDeviceCameraVideoSettings

Returns video settings for the given camera

meraki.getDeviceCameraVideoSettings({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

updateDeviceCameraVideoSettings

Update video settings for the given camera

meraki.updateDeviceCameraVideoSettings({
  "serial": ""
}, context)

Input

input object
- serial required string
- updateDeviceCameraVideoSettings object
  - externalRtspEnabled boolean: Boolean indicating if external rtsp stream is exposed

Output

output object

getDeviceCameraVideoLink

Returns video link to the specified camera. If a timestamp is supplied, it links to that timestamp.

meraki.getDeviceCameraVideoLink({
  "serial": ""
}, context)

Input

input object
- serial required string
- timestamp string: [optional] The video link will start at this time. The timestamp should be a string in ISO8601 format. If no timestamp is specified, we will assume current time.

Output

output object

getDeviceCellularGatewayLan

Show the LAN Settings of a MG

meraki.getDeviceCellularGatewayLan({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

updateDeviceCellularGatewayLan

Update the LAN Settings for a single MG.

meraki.updateDeviceCellularGatewayLan({
  "serial": ""
}, context)

Input

input object
- serial required string
- updateDeviceCellularGatewayLan object
  - fixedIpAssignments array: list of all fixed IP assignments for a single MG
    - items object
      - ip required string: The IP address you want to assign to a specific server or device
      - mac required string: The MAC address of the server or device that hosts the internal resource that you wish to receive the specified IP address
      - name string: A descriptive name of the assignment
  - reservedIpRanges array: list of all reserved IP ranges for a single MG
    - items object
      - comment required string: Comment explaining the reserved IP range
      - end required string: Ending IP included in the reserved range of IPs
      - start required string: Starting IP included in the reserved range of IPs

Output

output object

getDeviceCellularGatewayPortForwardingRules

Returns the port forwarding rules for a single MG.

meraki.getDeviceCellularGatewayPortForwardingRules({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

updateDeviceCellularGatewayPortForwardingRules

Updates the port forwarding rules for a single MG.

meraki.updateDeviceCellularGatewayPortForwardingRules({
  "serial": ""
}, context)

Input

input object
- serial required string
- updateDeviceCellularGatewayPortForwardingRules object
  - rules array: An array of port forwarding params
    - items object
      - access required string: any or restricted. Specify the right to make inbound connections on the specified ports or port ranges. If restricted, a list of allowed IPs is mandatory.
      - allowedIps array: An array of ranges of WAN IP addresses that are allowed to make inbound connections on the specified ports or port ranges.
        items string
      - lanIp required string: The IP address of the server or device that hosts the internal resource that you wish to make available on the WAN
      - localPort required string: A port or port ranges that will receive the forwarded traffic from the WAN
      - name string: A descriptive name for the rule
      - protocol required string: TCP or UDP
      - publicPort required string: A port or port ranges that will be forwarded to the host on the LAN

Output

output object

getDeviceClients

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.

meraki.getDeviceClients({
  "serial": ""
}, context)

Input

input object
- serial required string
- t0 string: The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
- timespan number: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

Output

output object

getDeviceLldpCdp

List LLDP and CDP information for a device

meraki.getDeviceLldpCdp({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

getDeviceLossAndLatencyHistory

Get the uplink loss percentage and latency in milliseconds for a wired network device.

meraki.getDeviceLossAndLatencyHistory({
  "serial": "",
  "ip": ""
}, context)

Input

input object
- serial required string
- t0 string: The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
- t1 string: The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
- timespan number: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.
- resolution integer: The time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60.
- uplink string (values: wan1, wan2, cellular): The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1.
- ip required string: The destination IP used to obtain the requested stats. This is required.

Output

output object

getDeviceManagementInterface

Return the management interface settings for a device

meraki.getDeviceManagementInterface({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

updateDeviceManagementInterface

Update the management interface settings for a device

meraki.updateDeviceManagementInterface({
  "serial": ""
}, context)

Input

input object
- serial required string
- updateDeviceManagementInterface object
  - wan1 object: WAN 1 settings
    - staticDns array: Up to two DNS IPs.
      - items string
    - staticGatewayIp string: The IP of the gateway on the WAN.
    - staticIp string: The IP the device should use on the WAN.
    - staticSubnetMask string: The subnet mask for the WAN.
    - usingStaticIp boolean: Configue the interface to have static IP settings or use DHCP.
    - vlan integer: The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    - wanEnabled string (values: enabled, disabled, not configured): Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.
  - wan2 object: WAN 2 settings (only for MX devices)
    - staticDns array: Up to two DNS IPs.
      - items string
    - staticGatewayIp string: The IP of the gateway on the WAN.
    - staticIp string: The IP the device should use on the WAN.
    - staticSubnetMask string: The subnet mask for the WAN.
    - usingStaticIp boolean: Configue the interface to have static IP settings or use DHCP.
    - vlan integer: The VLAN that management traffic should be tagged with. Applies whether usingStaticIp is true or false.
    - wanEnabled string (values: enabled, disabled, not configured): Enable or disable the interface (only for MX devices). Valid values are 'enabled', 'disabled', and 'not configured'.

Output

output object

rebootDevice

Reboot a device

meraki.rebootDevice({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

getDeviceSwitchPorts

List the switch ports for a switch

meraki.getDeviceSwitchPorts({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

cycleDeviceSwitchPorts

Cycle a set of switch ports

meraki.cycleDeviceSwitchPorts({
  "serial": "",
  "cycleDeviceSwitchPorts": {
    "ports": []
  }
}, context)

Input

input object
- serial required string
- cycleDeviceSwitchPorts required object
  - ports required array: List of switch ports. Example: [1, 2-5, 1_MA-MOD-8X10G_1, 1_MA-MOD-8X10G_2-1_MA-MOD-8X10G_8]
    - items string

Output

output object

getDeviceSwitchPortsStatuses

Return the status for all the ports of a switch

meraki.getDeviceSwitchPortsStatuses({
  "serial": ""
}, context)

Input

input object
- serial required string
- t0 string: The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
- timespan number: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

Output

output object

getDeviceSwitchPortsStatusesPackets

Return the packet counters for all the ports of a switch

meraki.getDeviceSwitchPortsStatusesPackets({
  "serial": ""
}, context)

Input

input object
- serial required string
- t0 string: The beginning of the timespan for the data. The maximum lookback period is 1 day from today.
- timespan number: The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 1 day. The default is 1 day.

Output

output object

getDeviceSwitchPort

Return a switch port

meraki.getDeviceSwitchPort({
  "serial": "",
  "portId": ""
}, context)

Input

input object
- serial required string
- portId required string

Output

output object

updateDeviceSwitchPort

Update a switch port

meraki.updateDeviceSwitchPort({
  "serial": "",
  "portId": ""
}, context)

Input

input object
- serial required string
- portId required string
- updateDeviceSwitchPort object
  - accessPolicyNumber integer: The number of a custom access policy to configure on the switch port. Only applicable when 'accessPolicyType' is 'Custom access policy'
  - accessPolicyType string (values: Open, Custom access policy, MAC allow list, Sticky MAC allow list): The type of the access policy of the switch port. Only applicable to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list' or 'Sticky MAC allow list'
  - allowedVlans string: The VLANs allowed on the switch port. Only applicable to trunk ports.
  - enabled boolean: The status of the switch port
  - flexibleStackingEnabled boolean: For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled.
  - isolationEnabled boolean: The isolation status of the switch port
  - linkNegotiation string: The link speed for the switch port
  - macAllowList array: Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'
    - items string
  - name string: The name of the switch port
  - poeEnabled boolean: The PoE status of the switch port
  - portScheduleId string: The ID of the port schedule. A value of null will clear the port schedule.
  - rstpEnabled boolean: The rapid spanning tree protocol status
  - stickyMacAllowList array: The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'
    - items string
  - stickyMacAllowListLimit integer: The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'
  - stormControlEnabled boolean: The storm control status of the switch port
  - stpGuard string (values: disabled, root guard, bpdu guard, loop guard): The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or 'loop guard')
  - tags array: The list of tags of the switch port
    - items string
  - type string (values: trunk, access): The type of the switch port ('trunk' or 'access')
  - udld string (values: Alert only, Enforce): The action to take when Unidirectional Link is detected (Alert only, Enforce). Default configuration is Alert only.
  - vlan integer: The VLAN of the switch port. A null value will clear the value set for trunk ports.
  - voiceVlan integer: The voice VLAN of the switch port. Only applicable to access ports.

Output

output object

getDeviceSwitchRoutingInterfaces

List layer 3 interfaces for a switch

meraki.getDeviceSwitchRoutingInterfaces({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

createDeviceSwitchRoutingInterface

Create a layer 3 interface for a switch

meraki.createDeviceSwitchRoutingInterface({
  "serial": "",
  "createDeviceSwitchRoutingInterface": {
    "name": "",
    "interfaceIp": "",
    "vlanId": 0
  }
}, context)

Input

input object
- serial required string
- createDeviceSwitchRoutingInterface required object
  - defaultGateway 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.
  - interfaceIp required 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.
  - multicastRouting string (values: disabled, enabled, IGMP snooping querier): Enable multicast support if, multicast routing between VLANs is required. Options are, 'disabled', 'enabled' or 'IGMP snooping querier'. Default is 'disabled'.
  - name required string: A friendly name or description for the interface or VLAN.
  - ospfSettings object: The OSPF routing settings of the interface.
    - area 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'.
    - cost integer: The path cost for this interface. Defaults to 1, but can be increased up to 65535 to give lower priority.
    - isPassiveEnabled boolean: When enabled, OSPF will not run on the interface, but the subnet will still be advertised.
  - subnet string: The network that this routed interface is on, in CIDR notation (ex. 10.1.1.0/24).
  - vlanId required integer: The VLAN this routed interface is on. VLAN must be between 1 and 4094.

Output

output object

deleteDeviceSwitchRoutingInterface

Delete a layer 3 interface from the switch

meraki.deleteDeviceSwitchRoutingInterface({
  "serial": "",
  "interfaceId": ""
}, context)

Input

input object
- serial required string
- interfaceId required string

Output

Output schema unknown

getDeviceSwitchRoutingInterface

Return a layer 3 interface for a switch

meraki.getDeviceSwitchRoutingInterface({
  "serial": "",
  "interfaceId": ""
}, context)

Input

input object
- serial required string
- interfaceId required string

Output

output object

updateDeviceSwitchRoutingInterface

Update a layer 3 interface for a switch

meraki.updateDeviceSwitchRoutingInterface({
  "serial": "",
  "interfaceId": ""
}, context)

Input

input object
- serial required string
- interfaceId required string
- updateDeviceSwitchRoutingInterface object
  - interfaceIp 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.
  - multicastRouting string (values: disabled, enabled, IGMP snooping querier): Enable multicast support if, multicast routing between VLANs is required. Options are, 'disabled', 'enabled' or 'IGMP snooping querier'.
  - name string: A friendly name or description for the interface or VLAN.
  - ospfSettings object: The OSPF routing settings of the interface.
    - area string: The OSPF area to which this interface should belong. Can be either 'disabled' or the identifier of an existing OSPF area.
    - cost integer: The path cost for this interface. Defaults to 1, but can be increased up to 65535 to give lower priority.
    - isPassiveEnabled boolean: When enabled, OSPF will not run on the interface, but the subnet will still be advertised.
  - subnet string: The network that this routed interface is on, in CIDR notation (ex. 10.1.1.0/24).
  - vlanId integer: The VLAN this routed interface is on. VLAN must be between 1 and 4094.

Output

output object

getDeviceSwitchRoutingInterfaceDhcp

Return a layer 3 interface DHCP configuration for a switch

meraki.getDeviceSwitchRoutingInterfaceDhcp({
  "serial": "",
  "interfaceId": ""
}, context)

Input

input object
- serial required string
- interfaceId required string

Output

output object

updateDeviceSwitchRoutingInterfaceDhcp

Update a layer 3 interface DHCP configuration for a switch

meraki.updateDeviceSwitchRoutingInterfaceDhcp({
  "serial": "",
  "interfaceId": ""
}, context)

Input

input object
- serial required string
- interfaceId required string
- updateDeviceSwitchRoutingInterfaceDhcp object
  - bootFileName string: The PXE boot server filename for the DHCP server running on the switch interface
  - bootNextServer string: The PXE boot server IP for the DHCP server running on the switch interface
  - bootOptionsEnabled boolean: Enable DHCP boot options to provide PXE boot options configs for the dhcp server running on the switch interface
  - dhcpLeaseTime string (values: 30 minutes, 1 hour, 4 hours, 12 hours, 1 day, 1 week): 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')
  - dhcpMode string (values: dhcpDisabled, dhcpRelay, dhcpServer): The DHCP mode options for the switch interface ('dhcpDisabled', 'dhcpRelay' or 'dhcpServer')
  - dhcpOptions array: Array of DHCP options consisting of code, type and value for the DHCP server running on the switch interface
    - items object
      - code required string: The code for DHCP option which should be from 2 to 254
      - type required string (values: text, ip, integer, hex): The type of the DHCP option which should be one of ('text', 'ip', 'integer' or 'hex')
      - value required string: The value of the DHCP option
  - dhcpRelayServerIps array: The DHCP relay server IPs to which DHCP packets would get relayed for the switch interface
    - items string
  - dnsCustomNameservers array: The DHCP name server IPs when DHCP name server option is 'custom'
    - items string
  - dnsNameserversOption string (values: googlePublicDns, openDns, custom): The DHCP name server option for the dhcp server running on the switch interface ('googlePublicDns', 'openDns' or 'custom')
  - fixedIpAssignments array: Array of DHCP fixed IP assignments for the DHCP server running on the switch interface
    - items object
      - ip required string: The IP address of the client which has fixed IP address assigned to it
      - mac required string: The MAC address of the client which has fixed IP address
      - name required string: The name of the client which has fixed IP address
  - reservedIpRanges array: Array of DHCP reserved IP assignments for the DHCP server running on the switch interface
    - items object
      - comment string: The comment for the reserved IP range
      - end required string: The ending IP address of the reserved IP range
      - start required string: The starting IP address of the reserved IP range

Output

output object

getDeviceSwitchRoutingStaticRoutes

List layer 3 static routes for a switch

meraki.getDeviceSwitchRoutingStaticRoutes({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

createDeviceSwitchRoutingStaticRoute

Create a layer 3 static route for a switch

meraki.createDeviceSwitchRoutingStaticRoute({
  "serial": "",
  "createDeviceSwitchRoutingStaticRoute": {
    "subnet": "",
    "nextHopIp": ""
  }
}, context)

Input

input object
- serial required string
- createDeviceSwitchRoutingStaticRoute required object
  - advertiseViaOspfEnabled boolean: Option to advertise static route via OSPF
  - name string: Name or description for layer 3 static route
  - nextHopIp required string: IP address of the next hop device to which the device sends its traffic for the subnet
  - preferOverOspfRoutesEnabled boolean: Option to prefer static route over OSPF routes
  - subnet required string: The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24)

Output

output object

deleteDeviceSwitchRoutingStaticRoute

Delete a layer 3 static route for a switch

meraki.deleteDeviceSwitchRoutingStaticRoute({
  "serial": "",
  "staticRouteId": ""
}, context)

Input

input object
- serial required string
- staticRouteId required string

Output

Output schema unknown

getDeviceSwitchRoutingStaticRoute

Return a layer 3 static route for a switch

meraki.getDeviceSwitchRoutingStaticRoute({
  "serial": "",
  "staticRouteId": ""
}, context)

Input

input object
- serial required string
- staticRouteId required string

Output

output object

updateDeviceSwitchRoutingStaticRoute

Update a layer 3 static route for a switch

meraki.updateDeviceSwitchRoutingStaticRoute({
  "serial": "",
  "staticRouteId": ""
}, context)

Input

input object
- serial required string
- staticRouteId required string
- updateDeviceSwitchRoutingStaticRoute object
  - advertiseViaOspfEnabled boolean: Option to advertise static route via OSPF
  - name string: Name or description for layer 3 static route
  - nextHopIp string: IP address of the next hop device to which the device sends its traffic for the subnet
  - preferOverOspfRoutesEnabled boolean: Option to prefer static route over OSPF routes
  - subnet string: The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24)

Output

output object

getDeviceSwitchWarmSpare

Return warm spare configuration for a switch

meraki.getDeviceSwitchWarmSpare({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

updateDeviceSwitchWarmSpare

Update warm spare configuration for a switch. The spare will use the same L3 configuration as the primary. Note that this will irreversibly destroy any existing L3 configuration on the spare.

meraki.updateDeviceSwitchWarmSpare({
  "serial": "",
  "updateDeviceSwitchWarmSpare": {
    "enabled": true
  }
}, context)

Input

input object
- serial required string
- updateDeviceSwitchWarmSpare required object
  - enabled required boolean: Enable or disable warm spare for a switch
  - spareSerial string: Serial number of the warm spare switch

Output

output object

getDeviceWirelessBluetoothSettings

Return the bluetooth settings for a wireless device

meraki.getDeviceWirelessBluetoothSettings({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

updateDeviceWirelessBluetoothSettings

Update the bluetooth settings for a wireless device

meraki.updateDeviceWirelessBluetoothSettings({
  "serial": ""
}, context)

Input

input object
- serial required string
- updateDeviceWirelessBluetoothSettings object
  - major integer: Desired major value of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value.
  - minor integer: Desired minor value of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value.
  - uuid string: Desired UUID of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value.

Output

output object

getDeviceWirelessConnectionStats

Aggregated connectivity info for a given AP on this network

meraki.getDeviceWirelessConnectionStats({
  "serial": ""
}, context)

Input

input object
- serial required string
- t0 string: The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
- t1 string: The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
- timespan number: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.
- band string (values: 2.4, 5): Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information.
- ssid integer: Filter results by SSID
- vlan integer: Filter results by VLAN
- apTag string: Filter results by AP Tag

Output

output object

getDeviceWirelessLatencyStats

Aggregated latency info for a given AP on this network

meraki.getDeviceWirelessLatencyStats({
  "serial": ""
}, context)

Input

input object
- serial required string
- t0 string: The beginning of the timespan for the data. The maximum lookback period is 180 days from today.
- t1 string: The end of the timespan for the data. t1 can be a maximum of 7 days after t0.
- timespan number: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.
- band string (values: 2.4, 5): Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information.
- ssid integer: Filter results by SSID
- vlan integer: Filter results by VLAN
- apTag string: Filter results by AP Tag
- fields string: Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.

Output

output object

getDeviceWirelessRadioSettings

Return the radio settings of a device

meraki.getDeviceWirelessRadioSettings({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

updateDeviceWirelessRadioSettings

Update the radio settings of a device

meraki.updateDeviceWirelessRadioSettings({
  "serial": ""
}, context)

Input

input object
- serial required string
- updateDeviceWirelessRadioSettings object
  - fiveGhzSettings object: Manual radio settings for 5 GHz.
    - channel integer (values: 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165, 169, 173, 177): Sets a manual channel for 5 GHz. Can be '36', '40', '44', '48', '52', '56', '60', '64', '100', '104', '108', '112', '116', '120', '124', '128', '132', '136', '140', '144', '149', '153', '157', '161', '165', '169', '173' or '177' or null for using auto channel.
    - channelWidth integer (values: 0, 20, 40, 80, 160): Sets a manual channel for 5 GHz. Can be '0', '20', '40', '80' or '160' or null for using auto channel width.
    - targetPower integer: Set a manual target power for 5 GHz. Can be between '8' or '30' or null for using auto power range.
  - rfProfileId integer: The ID of an RF profile to assign to the device. If the value of this parameter is null, the appropriate basic RF profile (indoor or outdoor) will be assigned to the device. Assigning an RF profile will clear ALL manually configured overrides on the device (channel width, channel, power).
  - twoFourGhzSettings object: Manual radio settings for 2.4 GHz.
    - channel integer (values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14): Sets a manual channel for 2.4 GHz. Can be '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13' or '14' or null for using auto channel.
    - targetPower integer: Set a manual target power for 2.4 GHz. Can be between '5' or '30' or null for using auto power range.

Output

output object

getDeviceWirelessStatus

Return the SSID statuses of an access point

meraki.getDeviceWirelessStatus({
  "serial": ""
}, context)

Input

input object
- serial required string

Output

output object

getNetworkClientsApplicationUsage

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.

meraki.getNetworkClientsApplicationUsage({
  "networkID": "",
  "clients": ""
}, context)

Input

input object
- networkID required string
- clients required string: A list of client keys, MACs or IPs separated by comma.
- ssidNumber integer (values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14): An SSID number to include. If not specified, eveusage histories application usagents for all SSIDs will be returned.
- perPage integer: The number of entries per page returned. Acceptable range is 3 - 1000.
- startingAfter string: A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
- endingBefore string: A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
- t0 string: The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
- t1 string: The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
- timespan number: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

Output

output object

getNetworkClientsUsageHistories

Return the usage histories 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.

meraki.getNetworkClientsUsageHistories({
  "networkID": "",
  "clients": ""
}, context)

Input

input object
- networkID required string
- clients required string: A list of client keys, MACs or IPs separated by comma.
- ssidNumber integer (values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14): An SSID number to include. If not specified, events for all SSIDs will be returned.
- perPage integer: The number of entries per page returned. Acceptable range is 3 - 1000.
- startingAfter string: A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
- endingBefore string: A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
- t0 string: The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
- t1 string: The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
- timespan number: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

Output

output object

deleteNetwork

Delete a network

meraki.deleteNetwork({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

Output schema unknown

getNetwork

Return a network

meraki.getNetwork({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

updateNetwork

Update a network

meraki.updateNetwork({
  "networkId": ""
}, context)

Input

input object
- networkId required string
- updateNetwork object
  - enrollmentString 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.
  - name string: The name of the network
  - tags array: A list of tags to be applied to the network
    - items string
  - timeZone string: The timezone of the network. For a list of allowed timezones, please see the 'TZ' column in the table in this article.

Output

output object

getNetworkAlertsSettings

Return the alert configuration for this network

meraki.getNetworkAlertsSettings({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

updateNetworkAlertsSettings

Update the alert configuration for this network

meraki.updateNetworkAlertsSettings({
  "networkId": ""
}, context)

Input

input object
- networkId required string
- updateNetworkAlertsSettings object
  - alerts array: Alert-specific configuration for each type. Only alerts that pertain to the network can be updated.
    - items object
      - alertDestinations object: A hash of destinations for this specific alert
        allAdmins boolean: If true, then all network admins will receive emails for this alert
        emails array: A list of emails that will receive information about the alert
        httpServerIds array: A list of HTTP server IDs to send a Webhook to for this alert
        snmp boolean: If true, then an SNMP trap will be sent for this alert if there is an SNMP trap server configured for this network
      - enabled boolean: A boolean depicting if the alert is turned on or off
      - filters object: A hash of specific configuration data for the alert. Only filters specific to the alert will be updated.
      - type required string: The type of alert
  - defaultDestinations object: The network-wide destinations for all alerts on the network.
    - allAdmins boolean: If true, then all network admins will receive emails.
    - emails array: A list of emails that will recieve the alert(s).
      - items string
    - httpServerIds array: A list of HTTP server IDs to send a Webhook to
      - items string
    - snmp boolean: If true, then an SNMP trap will be sent if there is an SNMP trap server configured for this network.

Output

output object

getNetworkApplianceClientSecurityEvents

List 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.

meraki.getNetworkApplianceClientSecurityEvents({
  "networkId": "",
  "clientId": ""
}, context)

Input

input object
- networkId required string
- clientId required string
- t0 string: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 791 days from today.
- t1 string: The end of the timespan for the data. t1 can be a maximum of 791 days after t0.
- timespan number: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 791 days. The default is 31 days.
- perPage integer: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.
- startingAfter string: A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
- endingBefore string: A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
- sortOrder string (values: ascending, descending): Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order.

Output

output object

getNetworkApplianceConnectivityMonitoringDestinations

Return the connectivity testing destinations for an MX network

meraki.getNetworkApplianceConnectivityMonitoringDestinations({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

updateNetworkApplianceConnectivityMonitoringDestinations

Update the connectivity testing destinations for an MX network

meraki.updateNetworkApplianceConnectivityMonitoringDestinations({
  "networkId": ""
}, context)

Input

input object
- networkId required string
- updateNetworkApplianceConnectivityMonitoringDestinations object
  - destinations array: The list of connectivity monitoring destinations
    - items object
      - default boolean: Boolean indicating whether this is the default testing destination (true) or not (false). Defaults to false. Only one default is allowed
      - description string: Description of the testing destination. Optional, defaults to null
      - ip required string: The IP address to test connectivity with

Output

output object

getNetworkApplianceContentFiltering

Return the content filtering settings for an MX network

meraki.getNetworkApplianceContentFiltering({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

updateNetworkApplianceContentFiltering

Update the content filtering settings for an MX network

meraki.updateNetworkApplianceContentFiltering({
  "networkId": ""
}, context)

Input

input object
- networkId required string
- updateNetworkApplianceContentFiltering object
  - allowedUrlPatterns array: A list of URL patterns that are allowed
    - items string
  - blockedUrlCategories array: A list of URL categories to block
    - items string
  - blockedUrlPatterns array: A list of URL patterns that are blocked
    - items string
  - urlCategoryListSize string (values: topSites, fullList): URL category list size which is either 'topSites' or 'fullList'

Output

output object

getNetworkApplianceContentFilteringCategories

List all available content filtering categories for an MX network

meraki.getNetworkApplianceContentFilteringCategories({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

getNetworkApplianceFirewallCellularFirewallRules

Return the cellular firewall rules for an MX network

meraki.getNetworkApplianceFirewallCellularFirewallRules({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

updateNetworkApplianceFirewallCellularFirewallRules

Update the cellular firewall rules of an MX network

meraki.updateNetworkApplianceFirewallCellularFirewallRules({
  "networkId": ""
}, context)

Input

input object
- networkId required string
- updateNetworkApplianceFirewallCellularFirewallRules object
  - rules array: An ordered array of the firewall rules (not including the default rule)
    - items object
      - comment string: Description of the rule (optional)
      - destCidr required 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 required string (values: allow, deny): 'allow' or 'deny' traffic specified by this rule
      - protocol required string (values: tcp, udp, icmp, any): The type of protocol (must be 'tcp', 'udp', 'icmp' or 'any')
      - srcCidr required 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)

Output

output object

getNetworkApplianceFirewallFirewalledServices

List the appliance services and their accessibility rules

meraki.getNetworkApplianceFirewallFirewalledServices({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

getNetworkApplianceFirewallFirewalledService

Return the accessibility settings of the given service ('ICMP', 'web', or 'SNMP')

meraki.getNetworkApplianceFirewallFirewalledService({
  "networkId": "",
  "service": ""
}, context)

Input

input object
- networkId required string
- service required string

Output

output object

updateNetworkApplianceFirewallFirewalledService

Updates the accessibility settings for the given service ('ICMP', 'web', or 'SNMP')

meraki.updateNetworkApplianceFirewallFirewalledService({
  "networkId": "",
  "service": "",
  "updateNetworkApplianceFirewallFirewalledService": {
    "access": ""
  }
}, context)

Input

input object
- networkId required string
- service required string
- updateNetworkApplianceFirewallFirewalledService required object
  - access required string (values: blocked, restricted, unrestricted): A string indicating the rule for which IPs are allowed to use the specified service. Acceptable values are "blocked" (no remote IPs can access the service), "restricted" (only allowed IPs can access the service), and "unrestriced" (any remote IP can access the service). This field is required
  - allowedIps array: An array of allowed IPs that can access the service. This field is required if "access" is set to "restricted". Otherwise this field is ignored
    - items string

Output

output object

getNetworkApplianceFirewallInboundFirewallRules

Return the inbound firewall rules for an MX network

meraki.getNetworkApplianceFirewallInboundFirewallRules({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

updateNetworkApplianceFirewallInboundFirewallRules

Update the inbound firewall rules of an MX network

meraki.updateNetworkApplianceFirewallInboundFirewallRules({
  "networkId": ""
}, context)

Input

input object
- networkId required string
- updateNetworkApplianceFirewallInboundFirewallRules object
  - rules array: An ordered array of the firewall rules (not including the default rule)
    - items object
      - comment string: Description of the rule (optional)
      - destCidr required 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 required string (values: allow, deny): 'allow' or 'deny' traffic specified by this rule
      - protocol required string (values: tcp, udp, icmp, any): The type of protocol (must be 'tcp', 'udp', 'icmp' or 'any')
      - srcCidr required 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)
  - syslogDefaultRule boolean: Log the special default rule (boolean value - enable only if you've configured a syslog server) (optional)

Output

output object

getNetworkApplianceFirewallL3FirewallRules

Return the L3 firewall rules for an MX network

meraki.getNetworkApplianceFirewallL3FirewallRules({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

updateNetworkApplianceFirewallL3FirewallRules

Update the L3 firewall rules of an MX network

meraki.updateNetworkApplianceFirewallL3FirewallRules({
  "networkId": ""
}, context)

Input

input object
- networkId required string
- updateNetworkApplianceFirewallL3FirewallRules object
  - rules array: An ordered array of the firewall rules (not including the default rule)
    - items object
      - comment string: Description of the rule (optional)
      - destCidr required 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 required string (values: allow, deny): 'allow' or 'deny' traffic specified by this rule
      - protocol required string (values: tcp, udp, icmp, any): The type of protocol (must be 'tcp', 'udp', 'icmp' or 'any')
      - srcCidr required 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)
  - syslogDefaultRule boolean: Log the special default rule (boolean value - enable only if you've configured a syslog server) (optional)

Output

output object

getNetworkApplianceFirewallL7FirewallRules

List the MX L7 firewall rules for an MX network

meraki.getNetworkApplianceFirewallL7FirewallRules({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

updateNetworkApplianceFirewallL7FirewallRules

Update the MX L7 firewall rules for an MX network

meraki.updateNetworkApplianceFirewallL7FirewallRules({
  "networkId": ""
}, context)

Input

input object
- networkId required string
- updateNetworkApplianceFirewallL7FirewallRules object
  - rules array: An ordered array of the MX L7 firewall rules
    - items object
      - policy string (values: deny): 'Deny' traffic specified by this rule
      - type string (values: application, applicationCategory, host, port, ipRange): Type of the L7 rule. One of: 'application', 'applicationCategory', 'host', 'port', 'ipRange'
      - value string: The 'value' of what you want to block. Format of 'value' varies depending on type of the rule. See sample request. The application categories and application ids can be retrieved from the the 'MX L7 application categories' endpoint. The countries follow the two-letter ISO 3166-1 alpha-2 format.

Output

output object

getNetworkApplianceFirewallL7FirewallRulesApplicationCategories

Return the L7 firewall application categories and their associated applications for an MX network

meraki.getNetworkApplianceFirewallL7FirewallRulesApplicationCategories({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

getNetworkApplianceFirewallOneToManyNatRules

Return the 1:Many NAT mapping rules for an MX network

meraki.getNetworkApplianceFirewallOneToManyNatRules({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

updateNetworkApplianceFirewallOneToManyNatRules

Set the 1:Many NAT mapping rules for an MX network

meraki.updateNetworkApplianceFirewallOneToManyNatRules({
  "networkId": "",
  "updateNetworkApplianceFirewallOneToManyNatRules": {
    "rules": []
  }
}, context)

Input

input object
- networkId required string
- updateNetworkApplianceFirewallOneToManyNatRules required object
  - rules required array: An array of 1:Many nat rules
    - items object
      - portRules required array: An array of associated forwarding rules
        items object
      - publicIp required string: The IP address that will be used to access the internal resource from the WAN
      - uplink required string (values: internet1, internet2): The physical WAN interface on which the traffic will arrive ('internet1' or, if available, 'internet2')

Output

output object

getNetworkApplianceFirewallOneToOneNatRules

Return the 1:1 NAT mapping rules for an MX network

meraki.getNetworkApplianceFirewallOneToOneNatRules({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

updateNetworkApplianceFirewallOneToOneNatRules

Set the 1:1 NAT mapping rules for an MX network

meraki.updateNetworkApplianceFirewallOneToOneNatRules({
  "networkId": "",
  "updateNetworkApplianceFirewallOneToOneNatRules": {
    "rules": []
  }
}, context)

Input

input object
- networkId required string
- updateNetworkApplianceFirewallOneToOneNatRules required object
  - rules required array: An array of 1:1 nat rules
    - items object
      - allowedInbound array: The ports this mapping will provide access on, and the remote IPs that will be allowed access to the resource
        items object
      - lanIp required string: The IP address of the server or device that hosts the internal resource that you wish to make available on the WAN
      - name string: A descriptive name for the rule
      - publicIp string: The IP address that will be used to access the internal resource from the WAN
      - uplink string (values: internet1, internet2): The physical WAN interface on which the traffic will arrive ('internet1' or, if available, 'internet2')

Output

output object

getNetworkApplianceFirewallPortForwardingRules

Return the port forwarding rules for an MX network

meraki.getNetworkApplianceFirewallPortForwardingRules({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

updateNetworkApplianceFirewallPortForwardingRules

Update the port forwarding rules for an MX network

meraki.updateNetworkApplianceFirewallPortForwardingRules({
  "networkId": "",
  "updateNetworkApplianceFirewallPortForwardingRules": {
    "rules": []
  }
}, context)

Input

input object
- networkId required string
- updateNetworkApplianceFirewallPortForwardingRules required object
  - rules required array: An array of port forwarding params
    - items object
      - allowedIps required array: An array of ranges of WAN IP addresses that are allowed to make inbound connections on the specified ports or port ranges (or any)
        items string
      - lanIp required string: The IP address of the server or device that hosts the internal resource that you wish to make available on the WAN
      - localPort required string: A port or port ranges that will receive the forwarded traffic from the WAN
      - name string: A descriptive name for the rule
      - protocol required string (values: tcp, udp): TCP or UDP
      - publicPort required string: A port or port ranges that will be forwarded to the host on the LAN
      - uplink string (values: internet1, internet2, both): The physical WAN interface on which the traffic will arrive ('internet1' or, if available, 'internet2' or 'both')

Output

output object

getNetworkAppliancePorts

List per-port VLAN settings for all ports of a MX.

meraki.getNetworkAppliancePorts({
  "networkId": ""
}, context)

Input

input object
- networkId required string

Output

output object

getNetworkAppliancePort

Return per-port VLAN settings for a single MX port.

meraki.getNetworkAppliancePort({
  "networkId": "",
  "portId": ""
}, context)

Input

input object
- networkId required string
- portId required string

Output

output object

updateNetworkAppliancePort

Update the per-port VLAN settings for a single MX port.

meraki.updateNetworkAppliancePort({
  "networkId": "",
  "portId": ""
}, context)

Input

input object
- networkId required string
- portId required string
- updateNetworkAppliancePort object
  - accessPolicy string: The name of the policy. Only applicable to Access ports. Valid values are: 'open', '8021x-r

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@datafire/meraki

Installation and Usage

Description

Actions

getDevice

Input

Output

updateDevice

Input

Output

getDeviceApplianceDhcpSubnets

Input

Output

getDeviceAppliancePerformance

Input

Output

blinkDeviceLeds

Input

Output

getDeviceCameraAnalyticsLive

Input

Output

getDeviceCameraAnalyticsOverview

Input

Output

getDeviceCameraAnalyticsRecent

Input

Output

getDeviceCameraAnalyticsZones

Input

Output

getDeviceCameraAnalyticsZoneHistory

Input

Output

generateDeviceCameraSnapshot

Input

Output

getDeviceCameraQualityAndRetention

Input

Output

updateDeviceCameraQualityAndRetention

Input

Output

getDeviceCameraSense

Input

Output

updateDeviceCameraSense

Input

Output

getDeviceCameraSenseObjectDetectionModels

Input

Output

getDeviceCameraVideoSettings

Input

Output

updateDeviceCameraVideoSettings

Input

Output

getDeviceCameraVideoLink

Input

Output

getDeviceCellularGatewayLan

Input

Output

updateDeviceCellularGatewayLan

Input

Output

getDeviceCellularGatewayPortForwardingRules

Input

Output

updateDeviceCellularGatewayPortForwardingRules

Input

Output

getDeviceClients