Appliance (Batch)

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.

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.

Connect a Cisco Umbrella account to this network.

API documentation: connectNetworkApplianceUmbrellaAccount

Parameters:

• network_id (str) –

  Network ID.

• api (ConnectNetworkApplianceUmbrellaAccountApi) –

  Umbrella API credentials.

Generate a new vMX authentication token.

API documentation: createDeviceApplianceVmxAuthenticationToken

Parameters:

• serial (str) –

  Serial.

Swap MX primary and warm spare appliances.

API documentation: createNetworkApplianceDevicesRedundancySwap

Parameters:

• network_id (str) –

  Network ID.

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.

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.

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.

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.

Create a new local DNS profile.

API documentation: createOrganizationApplianceDnsLocalProfile

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of 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.

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.

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.

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.

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.

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.

Delete a RF Profile.

API documentation: deleteNetworkApplianceRfProfile

Parameters:

• network_id (str) –

  Network ID.

• rf_profile_id (str) –

  Rf profile ID.

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.

Delete a VLAN from a network.

API documentation: deleteNetworkApplianceVlan

Parameters:

• network_id (str) –

  Network ID.

• vlan_id (str) –

  Vlan ID.

Deletes a local DNS profile.

API documentation: deleteOrganizationApplianceDnsLocalProfile

Parameters:

• organization_id (str) –

  Organization ID.

• profile_id (str) –

  Profile ID.

Deletes a local DNS record.

API documentation: deleteOrganizationApplianceDnsLocalRecord

Parameters:

• organization_id (str) –

  Organization ID.

• record_id (str) –

  Record ID.

Deletes a split DNS profile.

API documentation: deleteOrganizationApplianceDnsSplitProfile

Parameters:

• organization_id (str) –

  Organization ID.

• profile_id (str) –

  Profile ID.

Disconnect Umbrella account from this network.

API documentation: disconnectNetworkApplianceUmbrellaAccount

Parameters:

• network_id (str) –

  Network ID.

Remove VLANs from a policy.

API documentation: removeOrganizationPoliciesGlobalGroupPoliciesApplianceVlans

Parameters:

• organization_id (str) –

  Organization ID.

• policy (RemoveOrganizationPoliciesGlobalGroupPoliciesApplianceVlansPolicy) –

  Policy to remove VLANs from.

• vlans (list[RemoveOrganizationPoliciesGlobalGroupPoliciesApplianceVlansVlansItem]) –

  VLANs to remove.

Swap MX primary and warm spare appliances.

API documentation: swapNetworkApplianceWarmSpare

Parameters:

• network_id (str) –

  Network ID.

Update the radio settings of an appliance.

API documentation: updateDeviceApplianceRadioSettings

Parameters:

• serial (str) –

  Serial.

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

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

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

  Manual radio settings for 2.4 GHz.

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

  Manual radio settings for 5 GHz.

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

API documentation: updateDeviceApplianceUplinksSettings

Parameters:

• serial (str) –

  Serial.

• interfaces (UpdateDeviceApplianceUplinksSettingsInterfaces) –

  Interface settings.

Update the connectivity testing destinations for an MX network.

API documentation: updateNetworkApplianceConnectivityMonitoringDestinations

Parameters:

• network_id (str) –

  Network ID.

• destinations (list[UpdateNetworkApplianceConnectivityMonitoringDestinationsDestinationsItem] | None, default: None ) –

  The list of connectivity monitoring destinations.

Update MX warm spare settings.

API documentation: updateNetworkApplianceDevicesRedundancy

Parameters:

• network_id (str) –

  Network ID.

• enabled (bool) –

  Enable warm spare.

• mode (UpdateNetworkApplianceDevicesRedundancyMode | None, default: None ) –

  HA mode (disabled|active-passive|active-active).

• designations (list[UpdateNetworkApplianceDevicesRedundancyDesignationsItem] | None, default: None ) –

  Ordered warm spare roles.

• uplink (UpdateNetworkApplianceDevicesRedundancyUplink | None, default: None ) –

  Uplink configuration.

Update the MX L7 firewall rules for an MX network.

API documentation: updateNetworkApplianceFirewallL7FirewallRules

Parameters:

• network_id (str) –

  Network ID.

• rules (list[UpdateNetworkApplianceFirewallL7FirewallRulesRulesItem] | None, default: None ) –

  An ordered array of the MX L7 firewall rules. Each rule is an object with 'policy', 'type', and 'value'. The 'value' shape depends on 'type': object for application/applicationCategory, string for host/port/ipRange, and an array of 2-letter ISO 3166-1 alpha-2 country codes for allowedCountries/blockedCountries. For backward compatibility, request types also accept whitelistedCountries/blacklistedCountries.

Update static multicast forward rules for a network.

API documentation: updateNetworkApplianceFirewallMulticastForwarding

Parameters:

• network_id (str) –

  Network ID.

• rules (list[UpdateNetworkApplianceFirewallMulticastForwardingRulesItem]) –

  Static multicast forwarding rules. Pass an empty array to clear all rules.

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

API documentation: updateNetworkAppliancePort

Parameters:

• network_id (str) –

  Network ID.

• port_id (str) –

  Port ID.

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

  The status of the port.

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

  Trunk port can Drop all Untagged traffic. When true, no VLAN is required. Access ports cannot have dropUntaggedTraffic set to true.

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

  The type of the port: 'access' or 'trunk'.

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

  Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.

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

  Comma-delimited list of VLAN IDs (e.g. '2,15') for all devices. Secure Routers also support VLAN ranges (e.g. '2-10,15'). Use 'all' to permit all VLANs on the port.

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

  The name of the policy. Only applicable to Access ports. Valid values are: 'open', '8021x-radius', 'mac-radius', 'hybris-radius' for MX64 or Z3 or any MX supporting the per port authentication feature. Otherwise, 'open' is the only valid value and 'open' is the default value if the field is missing.

Update a static delegated prefix from a network.

API documentation: updateNetworkAppliancePrefixesDelegatedStatic

Parameters:

• network_id (str) –

  Network ID.

• static_delegated_prefix_id (str) –

  Static delegated prefix ID.

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

  A static IPv6 prefix.

• origin (UpdateNetworkAppliancePrefixesDelegatedStaticOrigin | None, default: None ) –

  The origin of the prefix.

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

  A name or description for the prefix.

Updates specified RF profile for this network.

API documentation: updateNetworkApplianceRfProfile

Parameters:

• network_id (str) –

  Network ID.

• rf_profile_id (str) –

  Rf profile ID.

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

  The name of the new profile. Must be unique.

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

  Settings related to 2.4Ghz band.

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

  Settings related to 5Ghz band.

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

  Per-SSID radio settings by number.

Update SDWAN internet traffic preferences for an MX network.

API documentation: updateNetworkApplianceSdwanInternetPolicies

Parameters:

• network_id (str) –

  Network ID.

• wan_traffic_uplink_preferences (list[UpdateNetworkApplianceSdwanInternetPoliciesWanTrafficUplinkPreferencesItem] | None, default: None ) –

  policies with respective traffic filters for an MX network.

Update the appliance settings for a network.

API documentation: updateNetworkApplianceSettings

Parameters:

• network_id (str) –

  Network ID.

• client_tracking_method (UpdateNetworkApplianceSettingsClientTrackingMethod | None, default: None ) –

  Client tracking method of a network.

• deployment_mode (UpdateNetworkApplianceSettingsDeploymentMode | None, default: None ) –

  Deployment mode of a network.

• dynamic_dns (UpdateNetworkApplianceSettingsDynamicDns | None, default: None ) –

  Dynamic DNS settings for a network.

Update single LAN configuration.

API documentation: updateNetworkApplianceSingleLan

Parameters:

• network_id (str) –

  Network ID.

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

  The subnet of the single LAN configuration.

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

  The appliance IP address of the single LAN.

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

  IPv6 configuration on the VLAN.

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

  Mandatory DHCP will enforce that clients connecting to this LAN 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.

Update the attributes of an MX SSID.

API documentation: updateNetworkApplianceSsid

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

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

  The name of the SSID.

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

  Whether or not the SSID is enabled.

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

  The VLAN ID of the VLAN associated to this SSID. This parameter is only valid if the network is in routed mode.

• auth_mode (UpdateNetworkApplianceSsidAuthMode | None, default: None ) –

  The association control method for the SSID ('open', 'psk', '8021x-meraki' or '8021x-radius').

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

  The passkey for the SSID. This param is only valid if the authMode is 'psk'.

• radius_servers (list[UpdateNetworkApplianceSsidRadiusServersItem] | None, default: None ) –

  The RADIUS 802.1x servers to be used for authentication. This param is only valid if the authMode is '8021x-radius'.

• encryption_mode (UpdateNetworkApplianceSsidEncryptionMode | None, default: None ) –

  The psk encryption mode for the SSID ('wep' or 'wpa'). This param is only valid if the authMode is 'psk'.

• wpa_encryption_mode (UpdateNetworkApplianceSsidWpaEncryptionMode | None, default: None ) –

  The types of WPA encryption. ('WPA1 and WPA2', 'WPA2 only', 'WPA3 Transition Mode' or 'WPA3 only'). This param is only valid if (1) the authMode is 'psk' & the encryptionMode is 'wpa' OR (2) the authMode is '8021x-meraki' OR (3) the authMode is '8021x-radius'.

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

  Boolean indicating whether the MX should advertise or hide this SSID.

• dhcp_enforced_deauthentication (UpdateNetworkApplianceSsidDhcpEnforcedDeauthentication | None, default: None ) –

  DHCP Enforced Deauthentication enables the disassociation of wireless clients in addition to Mandatory DHCP. This param is only valid on firmware versions >= MX 17.0 where the associated LAN has Mandatory DHCP Enabled.

• dot11w (UpdateNetworkApplianceSsidDot11w | None, default: None ) –

  The current setting for Protected Management Frames (802.11w).

Update a custom performance class for an MX network.

API documentation: updateNetworkApplianceTrafficShapingCustomPerformanceClass

Parameters:

• network_id (str) –

  Network ID.

• custom_performance_class_id (str) –

  Custom performance class ID.

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

  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.

Update the traffic shaping settings rules for an MX network.

API documentation: updateNetworkApplianceTrafficShapingRules

Parameters:

• network_id (str) –

  Network ID.

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

  Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8.

• rules (list[UpdateNetworkApplianceTrafficShapingRulesRulesItem] | None, default: None ) –

  An array of traffic shaping rules. Rules are applied in the order that they are specified in. An empty list (or null) means no rules. Note that you are allowed a maximum of 8 rules.

Updates the uplink bandwidth settings for your MX network.

API documentation: updateNetworkApplianceTrafficShapingUplinkBandwidth

Parameters:

• network_id (str) –

  Network ID.

• bandwidth_limits (UpdateNetworkApplianceTrafficShapingUplinkBandwidthBandwidthLimits | None, default: None ) –

  A mapping of uplinks to their bandwidth settings (be sure to check which uplinks are supported for your network).

Update uplink selection settings for an MX network.

API documentation: updateNetworkApplianceTrafficShapingUplinkSelection

Parameters:

• network_id (str) –

  Network ID.

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

  Toggle for enabling or disabling active-active AutoVPN.

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

  The default uplink. Must be a WAN interface 'wanX'.

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

  Toggle for enabling or disabling load balancing.

• failover_and_failback (UpdateNetworkApplianceTrafficShapingUplinkSelectionFailoverAndFailback | None, default: None ) –

  WAN failover and failback behavior.

• wan_traffic_uplink_preferences (list[UpdateNetworkApplianceTrafficShapingUplinkSelectionWanTrafficUplinkPreferencesItem] | None, default: None ) –

  Array of uplink preference rules for WAN traffic.

• vpn_traffic_uplink_preferences (list[UpdateNetworkApplianceTrafficShapingUplinkSelectionVpnTrafficUplinkPreferencesItem] | None, default: None ) –

  Array of uplink preference rules for VPN traffic.

Update VPN exclusion rules for an MX network.

API documentation: updateNetworkApplianceTrafficShapingVpnExclusions

Parameters:

• network_id (str) –

  Network ID.

• custom (list[UpdateNetworkApplianceTrafficShapingVpnExclusionsCustomItem] | None, default: None ) –

  Custom VPN exclusion rules. Pass an empty array to clear existing rules.

• major_applications (list[UpdateNetworkApplianceTrafficShapingVpnExclusionsMajorApplicationsItem] | None, default: None ) –

  Major Application based VPN exclusion rules. Pass an empty array to clear existing rules.

Update uplink NAT settings of the specified network.

API documentation: updateNetworkApplianceUplinksNat

Parameters:

• network_id (str) –

  Network ID.

• uplinks (list[UpdateNetworkApplianceUplinksNatUplinksItem]) –

  Per-uplink NAT exception configuration on the network.

Update a VLAN.

API documentation: updateNetworkApplianceVlan

Parameters:

• network_id (str) –

  Network ID.

• vlan_id (str) –

  Vlan ID.

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

  The name of the 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.

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

  The translated VPN subnet if VPN and VPN subnet translation are enabled on the VLAN.

• dhcp_handling (UpdateNetworkApplianceVlanDhcpHandling | 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 (UpdateNetworkApplianceVlanDhcpLeaseTime | 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'.

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

• fixed_ip_assignments (dict[str, Any] | None, default: None ) –

  The DHCP fixed IP assignments on the VLAN. This should be an object that contains mappings from MAC addresses to objects that themselves each contain "ip" and "name" string fields. See the sample request/response for more details.

• reserved_ip_ranges (list[UpdateNetworkApplianceVlanReservedIpRangesItem] | None, default: None ) –

  The DHCP reserved IP ranges on the VLAN.

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

  The DNS nameservers used for DHCP responses, either "upstream_dns", "google_dns", "opendns", or a newline seperated string of IP addresses or domain names.

• dhcp_options (list[UpdateNetworkApplianceVlanDhcpOptionsItem] | 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.

• template_vlan_type (UpdateNetworkApplianceVlanTemplateVlanType | 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 (UpdateNetworkApplianceVlanIpv6 | None, default: None ) –

  IPv6 configuration on the VLAN.

• mandatory_dhcp (UpdateNetworkApplianceVlanMandatoryDhcp | 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.

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

  VRF configuration on the VLAN.

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

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

Enable/Disable VLANs for the given network.

API documentation: updateNetworkApplianceVlansSettings

Parameters:

• network_id (str) –

  Network ID.

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

  Boolean indicating whether to enable (true) or disable (false) VLANs for the network.

Update a Hub BGP Configuration.

API documentation: updateNetworkApplianceVpnBgp

Parameters:

• network_id (str) –

  Network ID.

• enabled (bool) –

  Boolean value to enable or disable the BGP configuration. When BGP is enabled, the asNumber (ASN) will be autopopulated with the preconfigured ASN at other Hubs or a default value if there is no ASN configured.

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

  An Autonomous System Number (ASN) is required if you are to run BGP and peer with another BGP Speaker outside of the Auto VPN domain. This ASN will be applied to the entire Auto VPN domain. The entire 4-byte ASN range is supported. So, the ASN must be an integer between 1 and 4294967295. When absent, this field is not updated. If no value exists then it defaults to 64512.

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

  The iBGP holdtimer in seconds. The iBGP holdtimer must be an integer between 12 and 240. When absent, this field is not updated. If no value exists then it defaults to 240.

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

  The router ID of the appliance.

• neighbors (list[UpdateNetworkApplianceVpnBgpNeighborsItem] | None, default: None ) –

  List of BGP neighbors. This list replaces the existing set of neighbors. When absent, this field is not updated.

Update the site-to-site VPN settings of a network.

API documentation: updateNetworkApplianceVpnSiteToSiteVpn

Parameters:

• network_id (str) –

  Network ID.

• mode (UpdateNetworkApplianceVpnSiteToSiteVpnMode) –

  The site-to-site VPN mode. Can be one of 'none', 'spoke' or 'hub'.

• hubs (list[UpdateNetworkApplianceVpnSiteToSiteVpnHubsItem] | None, default: None ) –

  The list of VPN hubs, in order of preference. In spoke mode, at least 1 hub is required.

• subnets (list[UpdateNetworkApplianceVpnSiteToSiteVpnSubnetsItem] | None, default: None ) –

  The list of subnets and their VPN presence.

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

  Configuration of subnet features.

• host_translations (list[UpdateNetworkApplianceVpnSiteToSiteVpnHostTranslationsItem] | None, default: None ) –

  The list of VPN host translations. Host translations are supported starting from MX firmware version 26.1.2.

Update MX warm spare settings.

API documentation: updateNetworkApplianceWarmSpare

Parameters:

• network_id (str) –

  Network ID.

• enabled (bool) –

  Enable warm spare.

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

  Serial number of the warm spare appliance.

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

  Uplink mode, either virtual or public.

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

  The WAN 1 shared IP.

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

  The WAN 2 shared IP.

Update a local DNS profile.

API documentation: updateOrganizationApplianceDnsLocalProfile

Parameters:

• organization_id (str) –

  Organization ID.

• profile_id (str) –

  Profile ID.

• name (str) –

  Name of profile.

Updates a local DNS record.

API documentation: updateOrganizationApplianceDnsLocalRecord

Parameters:

• organization_id (str) –

  Organization ID.

• record_id (str) –

  Record ID.

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

  Hostname for the DNS record.

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

  IP for the DNS record.

• profile (UpdateOrganizationApplianceDnsLocalRecordProfile | None, default: None ) –

  The profile the DNS record is associated with.

Update a split DNS profile.

API documentation: updateOrganizationApplianceDnsSplitProfile

Parameters:

• organization_id (str) –

  Organization ID.

• profile_id (str) –

  Profile ID.

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

  Name of profile.

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

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

• nameservers (UpdateOrganizationApplianceDnsSplitProfileNameservers | None, default: None ) –

  Contains the nameserver information for redirection.

Update the VRF setting for an organization.

API documentation: updateOrganizationApplianceRoutingVrfsSettings

Parameters:

• organization_id (str) –

  Organization ID.

• enabled (bool) –

  Boolean indicating whether VRFs are enabled for the organization.

Update the IPsec SLA policies for an organization.

API documentation: updateOrganizationApplianceVpnSiteToSiteIpsecPeersSlas

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[UpdateOrganizationApplianceVpnSiteToSiteIpsecPeersSlasItemsItem] | None, default: None ) –

  List of IPsec SLA policies.

Update the third party VPN peers for an organization.

API documentation: updateOrganizationApplianceVpnThirdPartyVPNPeers

Parameters:

• organization_id (str) –

  Organization ID.

• peers (list[UpdateOrganizationApplianceVpnThirdPartyVPNPeersPeersItem]) –

  The list of VPN peers.