Appliance

Assign VLANs to a policy.

API documentation: assignOrganizationPoliciesGlobalGroupPoliciesApplianceVlans

Parameters:

• organization_id (str) –

  Organization ID.

• policy (AssignOrganizationPoliciesGlobalGroupPoliciesApplianceVlansPolicy) –

  Policy to assign VLANs to.

• vlans (list[AssignOrganizationPoliciesGlobalGroupPoliciesApplianceVlansVlansItem]) –

  VLANs to assign.

Returns:

• OrganizationPoliciesGlobalGroupPoliciesApplianceVlansResponse –

  Successful operation.

{
  "success": true
}

Assign the local DNS profile to networks in the organization.

API documentation: bulkOrganizationApplianceDnsLocalProfilesAssignmentsCreate

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[BulkOrganizationApplianceDnsLocalProfilesAssignmentsCreateItemsItem]) –

  List containing the network ID and Profile ID.

Returns:

• BulkOrganizationApplianceDnsLocalProfilesAssignmentsCreateResponse –

  Successful operation.

{
  "items": [
    {
      "assignmentId": "123456",
      "network": {
        "id": "N_123456"
      },
      "profile": {
        "id": "1234"
      }
    }
  ]
}

Connect a Cisco Umbrella account to this network.

API documentation: connectNetworkApplianceUmbrellaAccount

Parameters:

• network_id (str) –

  Network ID.

• api (ConnectNetworkApplianceUmbrellaAccountApi) –

  Umbrella API credentials.

Returns:

• ConnectNetworkApplianceUmbrellaAccountResponse –

  Successful operation.

{
  "umbrella": {
    "organization": {
      "id": "8769012"
    }
  }
}

Generate a new vMX authentication token.

API documentation: createDeviceApplianceVmxAuthenticationToken

Parameters:

• serial (str) –

  Serial.

Returns:

• CreateDeviceApplianceVmxAuthenticationTokenResponse –

  Successful operation.

{
  "token": "ffc0b7b578b61be5bd1d172132c78044/9af03bd84d474",
  "expiresAt": "2021-06-18T12:40:10Z"
}

Swap MX primary and warm spare appliances.

API documentation: createNetworkApplianceDevicesRedundancySwap

Parameters:

• network_id (str) –

  Network ID.

Returns:

• UpdateNetworkApplianceDevicesRedundancyResponse –

  Successful operation.

{
  "networkId": "L_12345",
  "name": "some_locale",
  "enabled": true,
  "mode": "active-active",
  "designations": [
    {
      "serial": "Q234-ABCD-5678",
      "priority": 1
    }
  ],
  "uplink": {
    "mode": "virtual",
    "interfaces": [
      {
        "name": "wan1",
        "addresses": [
          {
            "address": "1.2.3.4",
            "subnet": "192.168.1.0/24"
          }
        ]
      }
    ],
    "sharing": {
      "enabled": true,
      "vlanId": "100",
      "byInterface": [
        {
          "name": "wan1",
          "parent": "primary"
        }
      ]
    },
    "loadBalancing": {
      "enabled": true,
      "vlanSelection": {
        "mode": "auto",
        "byDevice": [
          {
            "serial": "Q234-ABCD-5678",
            "vlanIds": [
              1,
              2
            ]
          }
        ]
      }
    }
  }
}

Add a static delegated prefix from a network.

API documentation: createNetworkAppliancePrefixesDelegatedStatic

Parameters:

• network_id (str) –

  Network ID.

• prefix (str) –

  A static IPv6 prefix.

• origin (CreateNetworkAppliancePrefixesDelegatedStaticOrigin) –

  The origin of the prefix.

• description (str | None, default: None ) –

  A name or description for the prefix.

Returns:

• NetworkAppliancePrefixesDelegatedStaticResponse –

  Successful operation.

{
  "staticDelegatedPrefixId": "1284392014819",
  "prefix": "2001:db8:3c4d:15::/64",
  "origin": {
    "type": "internet",
    "interfaces": [
      "wan1"
    ]
  },
  "description": "Prefix on WAN 1 of Long Island Office network",
  "createdAt": "2018-05-12T00:00:00Z",
  "updatedAt": "2018-05-12T00:00:00Z"
}

Creates new RF profile for this network.

API documentation: createNetworkApplianceRfProfile

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  The name of the new profile. Must be unique. This param is required on creation.

• two_four_ghz_settings (CreateNetworkApplianceRfProfileTwoFourGhzSettings | None, default: None ) –

  Settings related to 2.4Ghz band.

• five_ghz_settings (CreateNetworkApplianceRfProfileFiveGhzSettings | None, default: None ) –

  Settings related to 5Ghz band.

• per_ssid_settings (CreateNetworkApplianceRfProfilePerSsidSettings | None, default: None ) –

  Per-SSID radio settings by number.

Returns:

• NetworkApplianceRfProfileResponse –

  Successful operation.

{
  "id": "1234",
  "networkId": "N_24329156",
  "name": "Some Custom RF Profile",
  "twoFourGhzSettings": {
    "minBitrate": 11.0,
    "axEnabled": true
  },
  "fiveGhzSettings": {
    "minBitrate": 12,
    "axEnabled": true
  },
  "perSsidSettings": {
    "1": {
      "bandOperationMode": "dual",
      "bandSteeringEnabled": true
    },
    "2": {
      "bandOperationMode": "dual",
      "bandSteeringEnabled": true
    },
    "3": {
      "bandOperationMode": "dual",
      "bandSteeringEnabled": true
    },
    "4": {
      "bandOperationMode": "dual",
      "bandSteeringEnabled": true
    }
  }
}

Add a static route for an MX or teleworker network.

API documentation: createNetworkApplianceStaticRoute

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  Name of the route.

• subnet (str) –

  Subnet of the route.

• gateway_ip (str) –

  Gateway IP address (next hop).

• gateway_vlan_id (int | None, default: None ) –

  Gateway VLAN ID.

Returns:

• NetworkApplianceStaticRouteResponse –

  Successful operation.

{
  "id": "d7fa4948-7921-4dfa-af6b-ae8b16c20c39",
  "ipVersion": 4,
  "networkId": "N_24329156",
  "enabled": true,
  "name": "My route",
  "subnet": "192.168.1.0/24",
  "gatewayIp": "1.2.3.5",
  "fixedIpAssignments": {
    "22:33:44:55:66:77": {
      "ip": "1.2.3.4",
      "name": "Some client name"
    }
  },
  "reservedIpRanges": [
    {
      "start": "192.168.1.0",
      "end": "192.168.1.1",
      "comment": "A reserved IP range"
    }
  ],
  "gatewayVlanId": 100
}

Add a custom performance class for an MX network.

API documentation: createNetworkApplianceTrafficShapingCustomPerformanceClass

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  Name of the custom performance class.

• max_latency (int | None, default: None ) –

  Maximum latency in milliseconds.

• max_jitter (int | None, default: None ) –

  Maximum jitter in milliseconds.

• max_loss_percentage (int | None, default: None ) –

  Maximum percentage of packet loss.

Returns:

• NetworkApplianceTrafficShapingCustomPerformanceClassResponse –

  Successful operation.

{
  "name": "myCustomPerformanceClass",
  "customPerformanceClassId": "123",
  "maxLatency": 100,
  "maxJitter": 100,
  "maxLossPercentage": 5
}

Add a VLAN.

API documentation: createNetworkApplianceVlan

Parameters:

• network_id (str) –

  Network ID.

• id (str) –

  The VLAN ID of the new VLAN (must be between 1 and 4094).

• name (str) –

  The name of the new VLAN.

• subnet (str | None, default: None ) –

  The subnet of the VLAN.

• appliance_ip (str | None, default: None ) –

  The local IP of the appliance on the VLAN.

• group_policy_id (str | None, default: None ) –

  The id of the desired group policy to apply to the VLAN.

• template_vlan_type (CreateNetworkApplianceVlanTemplateVlanType | None, default: None ) –

  Type of subnetting of the VLAN. Applicable only for template network.

• cidr (str | None, default: None ) –

  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.

• mask (int | None, default: None ) –

  Mask used for the subnet of all bound to the template networks. Applicable only for template network.

• ipv6 (CreateNetworkApplianceVlanIpv6 | None, default: None ) –

  IPv6 configuration on the VLAN.

• dhcp_handling (CreateNetworkApplianceVlanDhcpHandling | None, default: None ) –

  The appliance's handling of DHCP requests on this VLAN. One of: 'Run a DHCP server', 'Relay DHCP to another server' or 'Do not respond to DHCP requests'.

• dhcp_relay_server_ips (list[str] | None, default: None ) –

  The IPs (IPv4) of the DHCP servers that DHCP requests should be relayed to. CIDR/subnet notation and hostnames are not supported.

• dhcp_lease_time (CreateNetworkApplianceVlanDhcpLeaseTime | None, default: None ) –

  The term of DHCP leases if the appliance is running a DHCP server on this VLAN. One of: '30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week'.

• mandatory_dhcp (CreateNetworkApplianceVlanMandatoryDhcp | None, default: None ) –

  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.

• dhcp_boot_options_enabled (bool | None, default: None ) –

  Use DHCP boot options specified in other properties.

• dhcp_boot_next_server (str | None, default: None ) –

  DHCP boot option to direct boot clients to the server to load the boot file from.

• dhcp_boot_filename (str | None, default: None ) –

  DHCP boot option for boot filename.

• dhcp_options (list[CreateNetworkApplianceVlanDhcpOptionsItem] | None, default: None ) –

  The list of DHCP options that will be included in DHCP responses. Each object in the list should have "code", "type", and "value" properties.

• vrf (CreateNetworkApplianceVlanVrf | None, default: None ) –

  VRF configuration on the VLAN.

• uplinks (list[CreateNetworkApplianceVlanUplinksItem] | None, default: None ) –

  Per-uplink NAT exception override configuration on the VLAN. Applicable only for networks that support NAT exceptions.

Returns:

• CreateNetworkApplianceVlanResponse –

  Successful operation.

{
  "id": "1234",
  "interfaceId": "1284392014819",
  "name": "My VLAN",
  "subnet": "192.168.1.0/24",
  "applianceIp": "192.168.1.2",
  "groupPolicyId": "101",
  "templateVlanType": "same",
  "cidr": "192.168.1.0/24",
  "mask": 28,
  "mandatoryDhcp": {
    "enabled": true
  },
  "ipv6": {
    "enabled": true,
    "prefixAssignments": [
      {
        "autonomous": false,
        "staticPrefix": "2001:db8:3c4d:15::/64",
        "staticApplianceIp6": "2001:db8:3c4d:15::1",
        "origin": {
          "type": "internet",
          "interfaces": [
            "wan0"
          ]
        }
      }
    ]
  },
  "vrf": {
    "id": "1000",
    "name": "VRF BLUE"
  }
}

Create a new local DNS profile.

API documentation: createOrganizationApplianceDnsLocalProfile

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of profile.

Returns:

• OrganizationApplianceDnsLocalProfileResponse –

  Successful operation.

{
  "profileId": "123456",
  "name": "Default profile"
}

Unassign the local DNS profile to networks in the organization.

API documentation: createOrganizationApplianceDnsLocalProfilesAssignmentsBulkDelete

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[CreateOrganizationApplianceDnsLocalProfilesAssignmentsBulkDeleteItemsItem]) –

  List containing the assignment ID.

Returns:

• BulkOrganizationApplianceDnsLocalProfilesAssignmentsCreateResponse –

  Successful operation.

{
  "items": [
    {
      "assignmentId": "123456",
      "network": {
        "id": "N_123456"
      },
      "profile": {
        "id": "1234"
      }
    }
  ]
}

Create a new local DNS record.

API documentation: createOrganizationApplianceDnsLocalRecord

Parameters:

• organization_id (str) –

  Organization ID.

• hostname (str) –

  Hostname for the DNS record.

• address (str) –

  IP for the DNS record.

• profile (CreateOrganizationApplianceDnsLocalRecordProfile) –

  The profile the DNS record is associated with.

Returns:

• GetOrganizationApplianceDnsLocalRecordsResponse –

  Successful operation.

[
  {
    "recordId": "12345",
    "hostname": "www.test.com",
    "address": "10.1.1.0",
    "profile": {
      "id": "1"
    }
  }
]

Create a new split DNS profile.

API documentation: createOrganizationApplianceDnsSplitProfile

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of profile.

• hostnames (list[str]) –

  The hostname patterns to match for redirection. For more information on Split DNS hostname pattern formatting, please consult the Split DNS KB.

• nameservers (CreateOrganizationApplianceDnsSplitProfileNameservers) –

  Contains the nameserver information for redirection.

Returns:

• OrganizationApplianceDnsSplitProfileResponse –

  Successful operation.

{
  "profileId": "123456",
  "name": "Default profile",
  "hostnames": [
    "*.test1.com",
    "*.test2.com"
  ],
  "nameservers": {
    "addresses": [
      "12.1.10.1"
    ]
  }
}

Assign the split DNS profile to networks in the organization.

API documentation: createOrganizationApplianceDnsSplitProfilesAssignmentsBulkCreate

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[CreateOrganizationApplianceDnsSplitProfilesAssignmentsBulkCreateItemsItem]) –

  List containing the network ID and Profile ID.

Returns:

• BulkOrganizationApplianceDnsLocalProfilesAssignmentsCreateResponse –

  Successful operation.

{
  "items": [
    {
      "assignmentId": "123456",
      "network": {
        "id": "N_123456"
      },
      "profile": {
        "id": "1234"
      }
    }
  ]
}

Unassign the split DNS profile to networks in the organization.

API documentation: createOrganizationApplianceDnsSplitProfilesAssignmentsBulkDelete

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[CreateOrganizationApplianceDnsSplitProfilesAssignmentsBulkDeleteItemsItem]) –

  List containing the assignment ID.

Returns:

• BulkOrganizationApplianceDnsLocalProfilesAssignmentsCreateResponse –

  Successful operation.

{
  "items": [
    {
      "assignmentId": "123456",
      "network": {
        "id": "N_123456"
      },
      "profile": {
        "id": "1234"
      }
    }
  ]
}

Delete a static delegated prefix from a network.

API documentation: deleteNetworkAppliancePrefixesDelegatedStatic

Parameters:

• network_id (str) –

  Network ID.

• static_delegated_prefix_id (str) –

  Static delegated prefix ID.

Returns:

• None –

  Successful operation.

Delete a RF Profile.

API documentation: deleteNetworkApplianceRfProfile

Parameters:

• network_id (str) –

  Network ID.

• rf_profile_id (str) –

  Rf profile ID.

Returns:

• None –

  Successful operation.

Delete a static route from an MX or teleworker network.

API documentation: deleteNetworkApplianceStaticRoute

Parameters:

• network_id (str) –

  Network ID.

• static_route_id (str) –

  Static route ID.

Returns:

• None –

  Successful operation.

Delete a custom performance class from an MX network.

API documentation: deleteNetworkApplianceTrafficShapingCustomPerformanceClass

Parameters:

• network_id (str) –

  Network ID.

• custom_performance_class_id (str) –

  Custom performance class ID.

Returns:

• None –

  Successful operation.

Delete a VLAN from a network.

API documentation: deleteNetworkApplianceVlan

Parameters:

• network_id (str) –

  Network ID.

• vlan_id (str) –

  Vlan ID.

Returns:

• None –

  Successful operation.

Deletes a local DNS profile.

API documentation: deleteOrganizationApplianceDnsLocalProfile

Parameters:

• organization_id (str) –

  Organization ID.

• profile_id (str) –

  Profile ID.

Returns:

• None –

  Successful operation.

Deletes a local DNS record.

API documentation: deleteOrganizationApplianceDnsLocalRecord

Parameters:

• organization_id (str) –

  Organization ID.

• record_id (str) –

  Record ID.

Returns:

• None –

  Successful operation.

Deletes a split DNS profile.

API documentation: deleteOrganizationApplianceDnsSplitProfile

Parameters:

• organization_id (str) –

  Organization ID.

• profile_id (str) –

  Profile ID.

Returns:

• None –

  Successful operation.

Disconnect Umbrella account from this network.

API documentation: disconnectNetworkApplianceUmbrellaAccount

Parameters:

• network_id (str) –

  Network ID.

Returns:

• None –

  Successful operation.

Return the DHCP subnet information for an appliance.

API documentation: getDeviceApplianceDhcpSubnets

Parameters:

• serial (str) –

  Serial.

Returns:

• PaginatedResponse[GetDeviceApplianceDhcpSubnetsResponseItem] –

  Successful operation.

[
  {
    "subnet": "192.168.1.0/24",
    "vlanId": 100,
    "usedCount": 2,
    "freeCount": 251
  }
]

Return the performance score for a single MX.

API documentation: getDeviceAppliancePerformance

Parameters:

• serial (str) –

  Serial.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 30 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 14 days after t0.

• timespan (float | None, default: None ) –

  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 greater than or equal to 30 minutes and be less than or equal to 14 days. The default is 30 minutes.

Returns:

• GetDeviceAppliancePerformanceResponse | None –

  Successful operation.

{
  "perfScore": 10.0
}

Return current delegated IPv6 prefixes on an appliance.

API documentation: getDeviceAppliancePrefixesDelegated

Parameters:

• serial (str) –

  Serial.

Returns:

• PaginatedResponse[GetDeviceAppliancePrefixesDelegatedResponseItem] –

  Successful operation.

[
  {
    "origin": {
      "interface": "wan1"
    },
    "prefix": "2001:db8:3c4d:15::/64",
    "counts": {
      "assigned": 2,
      "available": 253
    },
    "method": "auto",
    "staticDelegatedPrefixId": "2001:db8:3c4d:15::/64",
    "description": "My ISP provider",
    "isPreferred": true,
    "expiresAt": "2018-05-12T00:00:00Z"
  }
]

Return prefixes assigned to all IPv6 enabled VLANs on an appliance.

API documentation: getDeviceAppliancePrefixesDelegatedVlanAssignments

Parameters:

• serial (str) –

  Serial.

Returns:

• PaginatedResponse[GetDeviceAppliancePrefixesDelegatedVlanAssignmentsResponseItem] –

  Successful operation.

[
  {
    "vlan": {
      "id": 100,
      "name": "My VLAN"
    },
    "origin": {
      "interface": "wan1",
      "prefix": "2001:db8:3c4d:15::/64"
    },
    "status": "Active",
    "ipv6": {
      "prefix": "2001:db8:3c4d:15::/64",
      "address": "2001:db8:3c4d:15::1",
      "linkLocal": {
        "address": "2001:db8:3c4d:15::1"
      },
      "solicitedNodeMulticast": {
        "address": "2001:db8:3c4d:15::1"
      }
    }
  }
]

Return the radio settings of an appliance.

API documentation: getDeviceApplianceRadioSettings

Parameters:

• serial (str) –

  Serial.

Returns:

• DeviceApplianceRadioSettingsResponse –

  Successful operation.

{
  "serial": "Q234-ABCD-5678",
  "rfProfileId": "1234",
  "twoFourGhzSettings": {
    "channel": 11,
    "targetPower": 21
  },
  "fiveGhzSettings": {
    "channel": 149,
    "channelWidth": 20,
    "targetPower": 15
  }
}

Return the uplink settings for a secure router or security appliance.

API documentation: getDeviceApplianceUplinksSettings

Parameters:

• serial (str) –

  Serial.

Returns:

• DeviceApplianceUplinksSettingsResponse –

  Successful operation.

{
  "interfaces": {
    "wan1": {
      "enabled": true,
      "vlanTagging": {
        "enabled": true,
        "vlanId": 1
      },
      "svis": {
        "ipv4": {
          "assignmentMode": "static",
          "address": "9.10.11.10/16",
          "gateway": "13.14.15.16",
          "nameservers": {
            "addresses": [
              "1.2.3.4"
            ]
          }
        },
        "ipv6": {
          "assignmentMode": "static",
          "address": "1:2:3::4",
          "gateway": "1:2:3::5",
          "nameservers": {
            "addresses": [
              "1001:4860:4860::8888",
              "1001:4860:4860::8844"
            ]
          }
        }
      },
      "pppoe": {
        "enabled": true,
        "authentication": {
          "enabled": true,
          "username": "username"
        }
      }
    },
    "wan2": {
      "enabled": true,
      "vlanTagging": {
        "enabled": true,
        "vlanId": 1
      },
      "svis": {
        "ipv4": {
          "assignmentMode": "static",
          "address": "9.10.11.10/16",
          "gateway": "13.14.15.16",
          "nameservers": {
            "addresses": [
              "1.2.3.4"
            ]
          }
        },
        "ipv6": {
          "assignmentMode": "static",
          "address": "1:2:3::4",
          "gateway": "1:2:3::5",
          "nameservers": {
            "addresses": [
              "1001:4860:4860::8888",
              "1001:4860:4860::8844"
            ]
          }
        }
      },
      "pppoe": {
        "enabled": true,
        "authentication": {
          "enabled": true,
          "username": "username"
        }
      }
    }
  }
}

List the security events for a client.

API documentation: getNetworkApplianceClientSecurityEvents

Parameters:

• network_id (str) –

  Network ID.

• client_id (str) –

  Client ID.

• t0 (str | None, default: None ) –

  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 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 791 days after t0.

• timespan (float | None, default: None ) –

  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.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.

• starting_after (str | None, default: None ) –

  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.

• ending_before (str | None, default: None ) –

  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.

• sort_order (GetNetworkApplianceClientSecurityEventsSortOrder | None, default: None ) –

  Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkApplianceClientSecurityEventsResponse] –

  Successful operation.

[
  {
    "ts": "2018-02-11T00:00:00.090210Z",
    "eventType": "File Scanned",
    "clientName": "COMPUTER-M-V78J",
    "clientMac": "10:dd:b1:eb:88:f8",
    "clientIp": "192.168.128.2",
    "srcIp": "192.168.128.2",
    "destIp": "119.192.233.48",
    "protocol": "http",
    "uri": "http://www.favorite-icons.com/program/FavoriteIconsUninstall.exe",
    "canonicalName": "PUA.Win.Dropper.Kraddare::1201",
    "destinationPort": 80,
    "fileHash": "3ec1b9a95fe62aa25fc959643a0f227b76d253094681934daaf628d3574b3463",
    "fileType": "MS_EXE",
    "fileSizeBytes": 193688,
    "disposition": "Malicious",
    "action": "Blocked"
  },
  {
    "ts": "2018-02-11T00:00:00.090210Z",
    "eventType": "IDS Alert",
    "deviceMac": "00:18:0a:01:02:03",
    "clientMac": "A1:B2:C3:D4:E5:F6",
    "srcIp": "1.2.3.4:34195",
    "destIp": "10.20.30.40:80",
    "protocol": "tcp/ip",
    "priority": "2",
    "classification": "4",
    "blocked": true,
    "message": "SERVER-WEBAPP JBoss JMX console access attempt",
    "signature": "1:21516:9",
    "sigSource": "",
    "ruleId": "meraki:intrusion/snort/GID/1/SID/26267"
  }
]

Return the connectivity testing destinations for an MX network.

API documentation: getNetworkApplianceConnectivityMonitoringDestinations

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceConnectivityMonitoringDestinationsResponse –

  Successful operation.

{
  "destinations": [
    {
      "ip": "1.2.3.4",
      "description": "Google",
      "default": false
    }
  ]
}

Return the content filtering settings for an MX network.

API documentation: getNetworkApplianceContentFiltering

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceContentFilteringResponse –

  Successful operation.

{
  "allowedUrlPatterns": [
    "http://www.example.org",
    "http://help.com.au"
  ],
  "blockedUrlPatterns": [
    "http://www.example.com",
    "http://www.betting.com"
  ],
  "blockedUrlCategories": [
    {
      "id": "meraki:contentFiltering/category/1",
      "name": "Real Estate"
    }
  ],
  "urlCategoryListSize": "topSites"
}

List all available content filtering categories for an MX network.

API documentation: getNetworkApplianceContentFilteringCategories

Parameters:

• network_id (str) –

  Network ID.

Returns:

• GetNetworkApplianceContentFilteringCategoriesResponse –

  Successful operation.

{
  "categories": [
    {
      "id": "meraki:contentFiltering/category/1",
      "name": "Real Estate"
    }
  ]
}

Return the cellular firewall rules for an MX network.

API documentation: getNetworkApplianceFirewallCellularFirewallRules

Parameters:

• network_id (str) –

  Network ID.

Returns:

• GetNetworkApplianceFirewallCellularFirewallRulesResponse –

  Successful operation.

{
  "rules": [
    {
      "comment": "Allow TCP traffic to subnet with HTTP servers.",
      "policy": "allow",
      "protocol": "tcp",
      "srcPort": "Any",
      "srcCidr": "Any",
      "destPort": "443",
      "destCidr": "192.168.1.0/24",
      "syslogEnabled": false
    }
  ]
}

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

API documentation: getNetworkApplianceFirewallFirewalledService

Parameters:

• network_id (str) –

  Network ID.

• service (str) –

  Service.

Returns:

• NetworkApplianceFirewallFirewalledServiceResponse –

  Successful operation.

{
  "service": "web",
  "access": "restricted",
  "allowedIps": [
    "123.123.123.1"
  ]
}

List the appliance services and their accessibility rules.

API documentation: getNetworkApplianceFirewallFirewalledServices

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkApplianceFirewallFirewalledServiceResponse] –

  Successful operation.

[
  {
    "service": "web",
    "access": "restricted",
    "allowedIps": [
      "123.123.123.1"
    ]
  }
]

Return the inbound cellular firewall rules for an MX network.

API documentation: getNetworkApplianceFirewallInboundCellularFirewallRules

Parameters:

• network_id (str) –

  Network ID.

Returns:

• GetNetworkApplianceFirewallCellularFirewallRulesResponse –

  Successful operation.

{
  "rules": [
    {
      "comment": "Allow TCP traffic to subnet with HTTP servers.",
      "policy": "allow",
      "protocol": "tcp",
      "srcPort": "Any",
      "srcCidr": "Any",
      "destPort": "443",
      "destCidr": "192.168.1.0/24",
      "syslogEnabled": false
    }
  ]
}

Return the inbound firewall rules for an MX network.

API documentation: getNetworkApplianceFirewallInboundFirewallRules

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceFirewallInboundFirewallRulesResponse –

  Successful operation.

{
  "rules": [
    {
      "comment": "Allow TCP traffic to subnet with HTTP servers.",
      "policy": "allow",
      "protocol": "tcp",
      "srcPort": "Any",
      "srcCidr": "Any",
      "destPort": "443",
      "destCidr": "192.168.1.0/24",
      "syslogEnabled": false
    }
  ],
  "syslogDefaultRule": false
}

Return the L3 firewall rules for an MX network.

API documentation: getNetworkApplianceFirewallL3FirewallRules

Parameters:

• network_id (str) –

  Network ID.

Returns:

• GetNetworkApplianceFirewallCellularFirewallRulesResponse –

  Successful operation.

{
  "rules": [
    {
      "comment": "Allow TCP traffic to subnet with HTTP servers.",
      "policy": "allow",
      "protocol": "tcp",
      "srcPort": "Any",
      "srcCidr": "Any",
      "destPort": "443",
      "destCidr": "192.168.1.0/24",
      "syslogEnabled": false
    }
  ]
}

List the MX L7 firewall rules for an MX network.

API documentation: getNetworkApplianceFirewallL7FirewallRules

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceFirewallL7FirewallRulesResponse –

  Successful operation.

{
  "rules": [
    {
      "policy": "deny",
      "type": "host",
      "value": "google.com"
    }
  ]
}

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

API documentation: getNetworkApplianceFirewallL7FirewallRulesApplicationCategories

Parameters:

• network_id (str) –

  Network ID.

Returns:

• GetNetworkApplianceFirewallL7FirewallRulesApplicationCategoriesResponse –

  Successful operation.

{
  "applicationCategories": [
    {
      "id": "meraki:layer7/category/24",
      "name": "Advertising",
      "applications": [
        {
          "id": "meraki:layer7/application/5",
          "name": "Advertising.com"
        }
      ]
    }
  ]
}

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

API documentation: getNetworkApplianceFirewallOneToManyNatRules

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceFirewallOneToManyNatRulesResponse –

  Successful operation.

{
  "rules": [
    {
      "publicIp": "146.11.11.13",
      "uplink": "internet1",
      "portRules": [
        {
          "name": "Rule 1",
          "protocol": "tcp",
          "publicPort": "9443",
          "localIp": "192.168.128.1",
          "localPort": "443",
          "allowedIps": [
            "any"
          ]
        }
      ]
    }
  ]
}

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

API documentation: getNetworkApplianceFirewallOneToOneNatRules

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceFirewallOneToOneNatRulesResponse –

  Successful operation.

{
  "rules": [
    {
      "name": "Service behind NAT",
      "publicIp": "146.12.3.33",
      "lanIp": "192.168.128.22",
      "uplink": "internet1",
      "allowedInbound": [
        {
          "protocol": "tcp",
          "destinationPorts": [
            "80"
          ],
          "allowedIps": [
            "10.82.112.0/24",
            "10.82.0.0/16"
          ]
        }
      ]
    }
  ]
}

Return the port forwarding rules for an MX network.

API documentation: getNetworkApplianceFirewallPortForwardingRules

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceFirewallPortForwardingRulesResponse –

  Successful operation.

{
  "rules": [
    {
      "lanIp": "192.168.128.1",
      "allowedIps": [
        "any"
      ],
      "name": "Description of Port Forwarding Rule",
      "protocol": "tcp",
      "publicPort": "8100-8101",
      "localPort": "442-443",
      "uplink": "both"
    }
  ]
}

Return the firewall settings for this network.

API documentation: getNetworkApplianceFirewallSettings

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceFirewallSettingsResponse –

  Successful operation.

{
  "spoofingProtection": {
    "ipSourceGuard": {
      "mode": "block"
    }
  }
}

Return per-port VLAN settings for a single secure router or security appliance port.

API documentation: getNetworkAppliancePort

Parameters:

• network_id (str) –

  Network ID.

• port_id (str) –

  Port ID.

Returns:

• NetworkAppliancePortResponse –

  Successful operation.

{
  "number": 1,
  "enabled": true,
  "type": "access",
  "dropUntaggedTraffic": false,
  "vlan": 3,
  "allowedVlans": "all",
  "accessPolicy": "open"
}

List per-port VLAN settings for all ports of a secure router or security appliance.

API documentation: getNetworkAppliancePorts

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkAppliancePortResponse] –

  Successful operation.

[
  {
    "number": 1,
    "enabled": true,
    "type": "access",
    "dropUntaggedTraffic": false,
    "vlan": 3,
    "allowedVlans": "all",
    "accessPolicy": "open"
  }
]

Return a static delegated prefix from a network.

API documentation: getNetworkAppliancePrefixesDelegatedStatic

Parameters:

• network_id (str) –

  Network ID.

• static_delegated_prefix_id (str) –

  Static delegated prefix ID.

Returns:

• NetworkAppliancePrefixesDelegatedStaticResponse –

  Successful operation.

{
  "staticDelegatedPrefixId": "1284392014819",
  "prefix": "2001:db8:3c4d:15::/64",
  "origin": {
    "type": "internet",
    "interfaces": [
      "wan1"
    ]
  },
  "description": "Prefix on WAN 1 of Long Island Office network",
  "createdAt": "2018-05-12T00:00:00Z",
  "updatedAt": "2018-05-12T00:00:00Z"
}

List static delegated prefixes for a network.

API documentation: getNetworkAppliancePrefixesDelegatedStatics

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkAppliancePrefixesDelegatedStaticResponse] –

  Successful operation.

[
  {
    "staticDelegatedPrefixId": "1284392014819",
    "prefix": "2001:db8:3c4d:15::/64",
    "origin": {
      "type": "internet",
      "interfaces": [
        "wan1"
      ]
    },
    "description": "Prefix on WAN 1 of Long Island Office network",
    "createdAt": "2018-05-12T00:00:00Z",
    "updatedAt": "2018-05-12T00:00:00Z"
  }
]

Return a RF profile.

API documentation: getNetworkApplianceRfProfile

Parameters:

• network_id (str) –

  Network ID.

• rf_profile_id (str) –

  Rf profile ID.

Returns:

• NetworkApplianceRfProfileResponse –

  Successful operation.

{
  "id": "1234",
  "networkId": "N_24329156",
  "name": "Some Custom RF Profile",
  "twoFourGhzSettings": {
    "minBitrate": 11.0,
    "axEnabled": true
  },
  "fiveGhzSettings": {
    "minBitrate": 12,
    "axEnabled": true
  },
  "perSsidSettings": {
    "1": {
      "bandOperationMode": "dual",
      "bandSteeringEnabled": true
    },
    "2": {
      "bandOperationMode": "dual",
      "bandSteeringEnabled": true
    },
    "3": {
      "bandOperationMode": "dual",
      "bandSteeringEnabled": true
    },
    "4": {
      "bandOperationMode": "dual",
      "bandSteeringEnabled": true
    }
  }
}

List the RF profiles for this network.

API documentation: getNetworkApplianceRfProfiles

Parameters:

• network_id (str) –

  Network ID.

Returns:

• GetNetworkApplianceRfProfilesResponse –

  Successful operation.

{
  "assigned": [
    {
      "id": "1234",
      "networkId": "N_24329156",
      "name": "Some Custom RF Profile",
      "twoFourGhzSettings": {
        "minBitrate": 11.0,
        "axEnabled": true
      },
      "fiveGhzSettings": {
        "minBitrate": 12,
        "axEnabled": true
      },
      "perSsidSettings": {
        "1": {
          "bandOperationMode": "dual",
          "bandSteeringEnabled": true
        },
        "2": {
          "bandOperationMode": "dual",
          "bandSteeringEnabled": true
        },
        "3": {
          "bandOperationMode": "dual",
          "bandSteeringEnabled": true
        },
        "4": {
          "bandOperationMode": "dual",
          "bandSteeringEnabled": true
        }
      }
    }
  ]
}

List the security events for a network.

API documentation: getNetworkApplianceSecurityEvents

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 365 days after t0.

• timespan (float | None, default: None ) –

  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 365 days. The default is 31 days.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.

• starting_after (str | None, default: None ) –

  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.

• ending_before (str | None, default: None ) –

  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.

• sort_order (GetNetworkApplianceSecurityEventsSortOrder | None, default: None ) –

  Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkApplianceClientSecurityEventsResponse] –

  Successful operation.

[
  {
    "ts": "2018-02-11T00:00:00.090210Z",
    "eventType": "File Scanned",
    "clientName": "COMPUTER-M-V78J",
    "clientMac": "10:dd:b1:eb:88:f8",
    "clientIp": "192.168.128.2",
    "srcIp": "192.168.128.2",
    "destIp": "119.192.233.48",
    "protocol": "http",
    "uri": "http://www.favorite-icons.com/program/FavoriteIconsUninstall.exe",
    "canonicalName": "PUA.Win.Dropper.Kraddare::1201",
    "destinationPort": 80,
    "fileHash": "3ec1b9a95fe62aa25fc959643a0f227b76d253094681934daaf628d3574b3463",
    "fileType": "MS_EXE",
    "fileSizeBytes": 193688,
    "disposition": "Malicious",
    "action": "Blocked"
  },
  {
    "ts": "2018-02-11T00:00:00.090210Z",
    "eventType": "IDS Alert",
    "deviceMac": "00:18:0a:01:02:03",
    "clientMac": "A1:B2:C3:D4:E5:F6",
    "srcIp": "1.2.3.4:34195",
    "destIp": "10.20.30.40:80",
    "protocol": "tcp/ip",
    "priority": "2",
    "classification": "4",
    "blocked": true,
    "message": "SERVER-WEBAPP JBoss JMX console access attempt",
    "signature": "1:21516:9",
    "sigSource": "",
    "ruleId": "meraki:intrusion/snort/GID/1/SID/26267"
  }
]

Returns all supported intrusion settings for an MX network.

API documentation: getNetworkApplianceSecurityIntrusion

Parameters:

• network_id (str) –

  Network ID.

Returns:

• GetNetworkApplianceSecurityIntrusionResponse –

  Successful operation.

{
  "mode": "prevention",
  "idsRulesets": "balanced",
  "protectedNetworks": {
    "useDefault": false,
    "includedCidr": [
      "10.0.0.0/8",
      "127.0.0.0/8",
      "169.254.0.0/16",
      "172.16.0.0/12"
    ],
    "excludedCidr": [
      "10.0.0.0/8",
      "127.0.0.0/8"
    ]
  }
}

Returns all supported malware settings for an MX network.

API documentation: getNetworkApplianceSecurityMalware

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceSecurityMalwareResponse –

  Successful operation.

{
  "mode": "enabled",
  "allowedUrls": [
    {
      "url": "help.com.au",
      "comment": "allow help.com.au"
    }
  ],
  "allowedFiles": [
    {
      "sha256": "e82c5f7d75004727e1f3b94426b9a11c8bc4c312a9170ac9a73abace40aef503",
      "comment": "allow ZIP file"
    }
  ]
}

Return the appliance settings for a network.

API documentation: getNetworkApplianceSettings

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceSettingsResponse –

  Successful operation.

{
  "clientTrackingMethod": "MAC address",
  "deploymentMode": "routed",
  "dynamicDns": {
    "enabled": true,
    "prefix": "test",
    "url": "test-adfgnnhjea.meraki.com"
  }
}

Return single LAN configuration.

API documentation: getNetworkApplianceSingleLan

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceSingleLanResponse –

  Successful operation.

{
  "subnet": "192.168.1.0/24",
  "applianceIp": "192.168.1.2",
  "mandatoryDhcp": {
    "enabled": true
  },
  "ipv6": {
    "enabled": true,
    "prefixAssignments": [
      {
        "autonomous": false,
        "staticPrefix": "2001:db8:3c4d:15::/64",
        "staticApplianceIp6": "2001:db8:3c4d:15::1",
        "origin": {
          "type": "internet",
          "interfaces": [
            "wan0"
          ]
        }
      }
    ]
  }
}

Return a single MX SSID.

API documentation: getNetworkApplianceSsid

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

Returns:

• NetworkApplianceSsidResponse –

  Successful operation.

{
  "number": 1,
  "name": "My SSID",
  "enabled": true,
  "defaultVlanId": 1,
  "authMode": "8021x-radius",
  "radiusServers": [
    {
      "host": "0.0.0.0",
      "port": 1000
    }
  ],
  "encryptionMode": "wpa",
  "wpaEncryptionMode": "WPA2 only",
  "visible": true
}

List the MX SSIDs in a network.

API documentation: getNetworkApplianceSsids

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkApplianceSsidResponse] –

  Successful operation.

[
  {
    "number": 1,
    "name": "My SSID",
    "enabled": true,
    "defaultVlanId": 1,
    "authMode": "8021x-radius",
    "radiusServers": [
      {
        "host": "0.0.0.0",
        "port": 1000
      }
    ],
    "encryptionMode": "wpa",
    "wpaEncryptionMode": "WPA2 only",
    "visible": true
  }
]

Return a static route for an MX or teleworker network.

API documentation: getNetworkApplianceStaticRoute

Parameters:

• network_id (str) –

  Network ID.

• static_route_id (str) –

  Static route ID.

Returns:

• NetworkApplianceStaticRouteResponse –

  Successful operation.

{
  "id": "d7fa4948-7921-4dfa-af6b-ae8b16c20c39",
  "ipVersion": 4,
  "networkId": "N_24329156",
  "enabled": true,
  "name": "My route",
  "subnet": "192.168.1.0/24",
  "gatewayIp": "1.2.3.5",
  "fixedIpAssignments": {
    "22:33:44:55:66:77": {
      "ip": "1.2.3.4",
      "name": "Some client name"
    }
  },
  "reservedIpRanges": [
    {
      "start": "192.168.1.0",
      "end": "192.168.1.1",
      "comment": "A reserved IP range"
    }
  ],
  "gatewayVlanId": 100
}

List the static routes for an MX or teleworker network.

API documentation: getNetworkApplianceStaticRoutes

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkApplianceStaticRouteResponse] –

  Successful operation.

[
  {
    "id": "d7fa4948-7921-4dfa-af6b-ae8b16c20c39",
    "ipVersion": 4,
    "networkId": "N_24329156",
    "enabled": true,
    "name": "My route",
    "subnet": "192.168.1.0/24",
    "gatewayIp": "1.2.3.5",
    "fixedIpAssignments": {
      "22:33:44:55:66:77": {
        "ip": "1.2.3.4",
        "name": "Some client name"
      }
    },
    "reservedIpRanges": [
      {
        "start": "192.168.1.0",
        "end": "192.168.1.1",
        "comment": "A reserved IP range"
      }
    ],
    "gatewayVlanId": 100
  }
]

Display the traffic shaping settings for an MX network.

API documentation: getNetworkApplianceTrafficShaping

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceTrafficShapingResponse –

  Successful operation.

{
  "globalBandwidthLimits": {
    "limitUp": 2048,
    "limitDown": 5120
  }
}

Return a custom performance class for an MX network.

API documentation: getNetworkApplianceTrafficShapingCustomPerformanceClass

Parameters:

• network_id (str) –

  Network ID.

• custom_performance_class_id (str) –

  Custom performance class ID.

Returns:

• NetworkApplianceTrafficShapingCustomPerformanceClassResponse –

  Successful operation.

{
  "name": "myCustomPerformanceClass",
  "customPerformanceClassId": "123",
  "maxLatency": 100,
  "maxJitter": 100,
  "maxLossPercentage": 5
}

List all custom performance classes for an MX network.

API documentation: getNetworkApplianceTrafficShapingCustomPerformanceClasses

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkApplianceTrafficShapingCustomPerformanceClassResponse] –

  Successful operation.

[
  {
    "name": "myCustomPerformanceClass",
    "customPerformanceClassId": "123",
    "maxLatency": 100,
    "maxJitter": 100,
    "maxLossPercentage": 5
  }
]

Display the traffic shaping settings rules for an MX network.

API documentation: getNetworkApplianceTrafficShapingRules

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceTrafficShapingRulesResponse –

  Successful operation.

{
  "defaultRulesEnabled": true,
  "rules": [
    {
      "definitions": [
        {
          "type": "host",
          "value": "google.com"
        }
      ],
      "perClientBandwidthLimits": {
        "settings": "custom",
        "bandwidthLimits": {
          "limitUp": 1000000,
          "limitDown": 1000000
        }
      },
      "dscpTagValue": 0,
      "priority": "normal"
    }
  ]
}

Returns the uplink bandwidth limits for your MX network.

API documentation: getNetworkApplianceTrafficShapingUplinkBandwidth

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceTrafficShapingUplinkBandwidthResponse –

  Successful operation.

{
  "bandwidthLimits": {
    "wan1": {
      "limitUp": 1000000,
      "limitDown": 1000000
    },
    "wan2": {
      "limitUp": 1000000,
      "limitDown": 1000000
    },
    "cellular": {
      "limitUp": 51200,
      "limitDown": 51200
    }
  }
}

Show uplink selection settings for an MX network.

API documentation: getNetworkApplianceTrafficShapingUplinkSelection

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceTrafficShapingUplinkSelectionResponse –

  Successful operation.

{
  "activeActiveAutoVpnEnabled": true,
  "defaultUplink": "wan1",
  "loadBalancingEnabled": true,
  "failoverAndFailback": {
    "immediate": {
      "enabled": true
    }
  },
  "wanTrafficUplinkPreferences": [
    {
      "trafficFilters": [
        {
          "type": "custom",
          "value": {
            "protocol": "tcp",
            "source": {
              "port": "1-1024",
              "cidr": "192.168.1.0/24",
              "vlan": 10,
              "host": 254
            },
            "destination": {
              "port": "any",
              "cidr": "any",
              "applications": [
                {
                  "id": "meraki:layer7/application/3",
                  "name": "DNS",
                  "type": "major"
                }
              ]
            }
          }
        }
      ],
      "preferredUplink": "wan1"
    }
  ],
  "vpnTrafficUplinkPreferences": [
    {
      "trafficFilters": [
        {
          "type": "applicationCategory",
          "value": {
            "id": "meraki:layer7/category/1",
            "protocol": "tcp",
            "source": {
              "port": "any",
              "cidr": "192.168.1.0/24",
              "network": "L_23456789",
              "vlan": 20,
              "host": 200
            },
            "destination": {
              "port": "1-1024",
              "cidr": "any",
              "network": "L_12345678",
              "vlan": 10,
              "host": 254,
              "fqdn": "www.google.com"
            }
          }
        }
      ],
      "preferredUplink": "bestForVoIP",
      "failOverCriterion": "poorPerformance",
      "performanceClass": {
        "type": "custom",
        "builtinPerformanceClassName": "VoIP",
        "customPerformanceClassId": "123456"
      }
    }
  ]
}

Get the sent and received bytes for each uplink of a network.

API documentation: getNetworkApplianceUplinksUsageHistory

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 365 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 31 days after t0.

• timespan (float | None, default: None ) –

  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 10 minutes.

• resolution (int | None, default: None ) –

  The time resolution in seconds for returned data. The valid resolutions are: 60, 300, 600, 1800, 3600, 86400. The default is 60.

Returns:

• PaginatedResponse[GetNetworkApplianceUplinksUsageHistoryResponseItem] –

  Successful operation.

[
  {
    "startTime": "2021-07-22T02:00:00Z",
    "endTime": "2021-07-22T03:00:00Z",
    "byInterface": [
      {
        "interface": "wan1",
        "sent": 1562063,
        "received": 9528787
      }
    ]
  }
]

Return a VLAN.

API documentation: getNetworkApplianceVlan

Parameters:

• network_id (str) –

  Network ID.

• vlan_id (str) –

  Vlan ID.

Returns:

• NetworkApplianceVlanResponse –

  Successful operation.

{
  "id": "1234",
  "interfaceId": "1284392014819",
  "name": "My VLAN",
  "subnet": "192.168.1.0/24",
  "applianceIp": "192.168.1.2",
  "groupPolicyId": "101",
  "templateVlanType": "same",
  "cidr": "192.168.1.0/24",
  "mask": 28,
  "dhcpRelayServerIps": [
    "192.168.1.0",
    "192.168.128.0"
  ],
  "dhcpHandling": "Run a DHCP server",
  "dhcpLeaseTime": "1 day",
  "dhcpBootOptionsEnabled": false,
  "dhcpBootNextServer": "1.2.3.4",
  "dhcpBootFilename": "sample.file",
  "fixedIpAssignments": {
    "00:11:22:33:44:55": {
      "ip": "1.2.3.4",
      "name": "My favorite IP"
    }
  },
  "reservedIpRanges": [
    {
      "start": "192.168.1.0",
      "end": "192.168.1.1",
      "comment": "A reserved IP range"
    }
  ],
  "dnsNameservers": "google_dns",
  "dhcpOptions": [
    {
      "code": "5",
      "type": "text",
      "value": "five"
    }
  ],
  "vpnNatSubnet": "192.168.1.0/24",
  "mandatoryDhcp": {
    "enabled": true
  },
  "ipv6": {
    "enabled": true,
    "prefixAssignments": [
      {
        "autonomous": false,
        "staticPrefix": "2001:db8:3c4d:15::/64",
        "staticApplianceIp6": "2001:db8:3c4d:15::1",
        "origin": {
          "type": "internet",
          "interfaces": [
            "wan0"
          ]
        }
      }
    ]
  },
  "vrf": {
    "id": "1000",
    "name": "VRF BLUE"
  }
}

List the VLANs for a Security Appliance network.

API documentation: getNetworkApplianceVlans

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkApplianceVlanResponse] –

  Successful operation.

[
  {
    "id": "1234",
    "interfaceId": "1284392014819",
    "name": "My VLAN",
    "subnet": "192.168.1.0/24",
    "applianceIp": "192.168.1.2",
    "groupPolicyId": "101",
    "templateVlanType": "same",
    "cidr": "192.168.1.0/24",
    "mask": 28,
    "dhcpRelayServerIps": [
      "192.168.1.0",
      "192.168.128.0"
    ],
    "dhcpHandling": "Run a DHCP server",
    "dhcpLeaseTime": "1 day",
    "dhcpBootOptionsEnabled": false,
    "dhcpBootNextServer": "1.2.3.4",
    "dhcpBootFilename": "sample.file",
    "fixedIpAssignments": {
      "00:11:22:33:44:55": {
        "ip": "1.2.3.4",
        "name": "My favorite IP"
      }
    },
    "reservedIpRanges": [
      {
        "start": "192.168.1.0",
        "end": "192.168.1.1",
        "comment": "A reserved IP range"
      }
    ],
    "dnsNameservers": "google_dns",
    "dhcpOptions": [
      {
        "code": "5",
        "type": "text",
        "value": "five"
      }
    ],
    "vpnNatSubnet": "192.168.1.0/24",
    "mandatoryDhcp": {
      "enabled": true
    },
    "ipv6": {
      "enabled": true,
      "prefixAssignments": [
        {
          "autonomous": false,
          "staticPrefix": "2001:db8:3c4d:15::/64",
          "staticApplianceIp6": "2001:db8:3c4d:15::1",
          "origin": {
            "type": "internet",
            "interfaces": [
              "wan0"
            ]
          }
        }
      ]
    },
    "vrf": {
      "id": "1000",
      "name": "VRF BLUE"
    }
  }
]

Returns the enabled status of VLANs for the network.

API documentation: getNetworkApplianceVlansSettings

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceVlansSettingsResponse –

  Successful operation.

{
  "vlansEnabled": true
}

Return a Hub BGP Configuration.

API documentation: getNetworkApplianceVpnBgp

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkApplianceVpnBgpResponse –

  Successful operation.

{
  "enabled": true,
  "asNumber": 64515,
  "ibgpHoldTimer": 120,
  "routerId": "10.15.10.2",
  "neighbors": [
    {
      "ip": "10.10.10.22",
      "ipv6": {
        "address": "2002::1234:abcd:ffff:c0a8:101"
      },
      "remoteAsNumber": 64343,
      "receiveLimit": 120,
      "allowTransit": true,
      "ebgpHoldTimer": 180,
      "ebgpMultihop": 2,
      "sourceInterface": "wan1",
      "nextHopIp": "1.2.3.4",
      "ttlSecurity": {
        "enabled": false
      },
      "authentication": {
        "password": "abc123"
      },
      "multiExitDiscriminator": 2,
      "pathPrepend": [
        1,
        2
      ],
      "weight": 10,
      "filterIn": [
        "10.0.0.0/8",
        "172.16.0.0/12"
      ],
      "communityOut": [
        "64515:100",
        "NO_EXPORT"
      ]
    }
  ]
}