class ActionBatchAppliance(object): def __init__(self): super(ActionBatchAppliance, self).__init__() def updateNetworkApplianceConnectivityMonitoringDestinations(self, networkId: str, **kwargs): """ **Update the connectivity testing destinations for an MX network** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-connectivity-monitoring-destinations - networkId (string): (required) - destinations (array): The list of connectivity monitoring destinations """ kwargs.update(locals()) metadata = { 'tags': ['appliance', 'configure', 'connectivityMonitoringDestinations'], 'operation': 'updateNetworkApplianceConnectivityMonitoringDestinations' } resource = f'/networks/{networkId}/appliance/connectivityMonitoringDestinations' body_params = ['destinations', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def updateNetworkApplianceFirewallL7FirewallRules(self, networkId: str, **kwargs): """ **Update the MX L7 firewall rules for an MX network** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-firewall-l-7-firewall-rules - networkId (string): (required) - rules (array): An ordered array of the MX L7 firewall rules """ kwargs.update(locals()) metadata = { 'tags': ['appliance', 'configure', 'firewall', 'l7FirewallRules'], 'operation': 'updateNetworkApplianceFirewallL7FirewallRules' } resource = f'/networks/{networkId}/appliance/firewall/l7FirewallRules' body_params = ['rules', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def updateNetworkAppliancePort(self, networkId: str, portId: str, **kwargs): """ **Update the per-port VLAN settings for a single MX port.** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-port - networkId (string): (required) - portId (string): (required) - enabled (boolean): The status of the port - dropUntaggedTraffic (boolean): Trunk port can Drop all Untagged traffic. When true, no VLAN is required. Access ports cannot have dropUntaggedTraffic set to true. - type (string): The type of the port: 'access' or 'trunk'. - vlan (integer): Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode. - allowedVlans (string): Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port. - accessPolicy (string): The name of the policy. Only applicable to Access ports. Valid values are: 'open', '8021x-radius', 'mac-radius', 'hybris-radius' for MX64 or Z3 or any MX supporting the per port authentication feature. Otherwise, 'open' is the only valid value and 'open' is the default value if the field is missing. """ kwargs.update(locals()) metadata = { 'tags': ['appliance', 'configure', 'ports'], 'operation': 'updateNetworkAppliancePort' } resource = f'/networks/{networkId}/appliance/ports/{portId}' body_params = ['enabled', 'dropUntaggedTraffic', 'type', 'vlan', 'allowedVlans', 'accessPolicy', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def updateNetworkApplianceSingleLan(self, networkId: str, **kwargs): """ **Update single LAN configuration** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-single-lan - networkId (string): (required) - subnet (string): The subnet of the single LAN configuration - applianceIp (string): The appliance IP address of the single LAN """ kwargs.update(locals()) metadata = { 'tags': ['appliance', 'configure', 'singleLan'], 'operation': 'updateNetworkApplianceSingleLan' } resource = f'/networks/{networkId}/appliance/singleLan' body_params = ['subnet', 'applianceIp', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def createNetworkApplianceTrafficShapingCustomPerformanceClass(self, networkId: str, name: str, **kwargs): """ **Add a custom performance class for an MX network** https://developer.cisco.com/meraki/api-v1/#!create-network-appliance-traffic-shaping-custom-performance-class - networkId (string): (required) - name (string): Name of the custom performance class - maxLatency (integer): Maximum latency in milliseconds - maxJitter (integer): Maximum jitter in milliseconds - maxLossPercentage (integer): Maximum percentage of packet loss """ kwargs.update(locals()) metadata = { 'tags': ['appliance', 'configure', 'trafficShaping', 'customPerformanceClasses'], 'operation': 'createNetworkApplianceTrafficShapingCustomPerformanceClass' } resource = f'/networks/{networkId}/appliance/trafficShaping/customPerformanceClasses' body_params = ['name', 'maxLatency', 'maxJitter', 'maxLossPercentage', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "create", "body": payload } return action def updateNetworkApplianceTrafficShapingCustomPerformanceClass(self, networkId: str, customPerformanceClassId: str, **kwargs): """ **Update a custom performance class for an MX network** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-traffic-shaping-custom-performance-class - networkId (string): (required) - customPerformanceClassId (string): (required) - name (string): Name of the custom performance class - maxLatency (integer): Maximum latency in milliseconds - maxJitter (integer): Maximum jitter in milliseconds - maxLossPercentage (integer): Maximum percentage of packet loss """ kwargs.update(locals()) metadata = { 'tags': ['appliance', 'configure', 'trafficShaping', 'customPerformanceClasses'], 'operation': 'updateNetworkApplianceTrafficShapingCustomPerformanceClass' } resource = f'/networks/{networkId}/appliance/trafficShaping/customPerformanceClasses/{customPerformanceClassId}' body_params = ['name', 'maxLatency', 'maxJitter', 'maxLossPercentage', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def deleteNetworkApplianceTrafficShapingCustomPerformanceClass(self, networkId: str, customPerformanceClassId: str): """ **Delete a custom performance class from an MX network** https://developer.cisco.com/meraki/api-v1/#!delete-network-appliance-traffic-shaping-custom-performance-class - networkId (string): (required) - customPerformanceClassId (string): (required) """ metadata = { 'tags': ['appliance', 'configure', 'trafficShaping', 'customPerformanceClasses'], 'operation': 'deleteNetworkApplianceTrafficShapingCustomPerformanceClass' } resource = f'/networks/{networkId}/appliance/trafficShaping/customPerformanceClasses/{customPerformanceClassId}' action = { "resource": resource, "operation": "destroy", "body": payload } return action def updateNetworkApplianceTrafficShapingRules(self, networkId: str, **kwargs): """ **Update the traffic shaping settings rules for an MX network** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-traffic-shaping-rules - networkId (string): (required) - defaultRulesEnabled (boolean): 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 (array): 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. """ kwargs.update(locals()) metadata = { 'tags': ['appliance', 'configure', 'trafficShaping', 'rules'], 'operation': 'updateNetworkApplianceTrafficShapingRules' } resource = f'/networks/{networkId}/appliance/trafficShaping/rules' body_params = ['defaultRulesEnabled', 'rules', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def updateNetworkApplianceTrafficShapingUplinkBandwidth(self, networkId: str, **kwargs): """ **Updates the uplink bandwidth settings for your MX network.** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-traffic-shaping-uplink-bandwidth - networkId (string): (required) - bandwidthLimits (object): A mapping of uplinks to their bandwidth settings (be sure to check which uplinks are supported for your network) """ kwargs.update(locals()) metadata = { 'tags': ['appliance', 'configure', 'trafficShaping', 'uplinkBandwidth'], 'operation': 'updateNetworkApplianceTrafficShapingUplinkBandwidth' } resource = f'/networks/{networkId}/appliance/trafficShaping/uplinkBandwidth' body_params = ['bandwidthLimits', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def updateNetworkApplianceTrafficShapingUplinkSelection(self, networkId: str, **kwargs): """ **Update uplink selection settings for an MX network** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-traffic-shaping-uplink-selection - networkId (string): (required) - activeActiveAutoVpnEnabled (boolean): Toggle for enabling or disabling active-active AutoVPN - defaultUplink (string): The default uplink. Must be one of: 'wan1' or 'wan2' - loadBalancingEnabled (boolean): Toggle for enabling or disabling load balancing - wanTrafficUplinkPreferences (array): Array of uplink preference rules for WAN traffic - vpnTrafficUplinkPreferences (array): Array of uplink preference rules for VPN traffic """ kwargs.update(locals()) if 'defaultUplink' in kwargs: options = ['wan1', 'wan2'] assert kwargs['defaultUplink'] in options, f'''"defaultUplink" cannot be "{kwargs['defaultUplink']}", & must be set to one of: {options}''' metadata = { 'tags': ['appliance', 'configure', 'trafficShaping', 'uplinkSelection'], 'operation': 'updateNetworkApplianceTrafficShapingUplinkSelection' } resource = f'/networks/{networkId}/appliance/trafficShaping/uplinkSelection' body_params = ['activeActiveAutoVpnEnabled', 'defaultUplink', 'loadBalancingEnabled', 'wanTrafficUplinkPreferences', 'vpnTrafficUplinkPreferences', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def createNetworkApplianceVlan(self, networkId: str, id: str, name: str, **kwargs): """ **Add a VLAN** https://developer.cisco.com/meraki/api-v1/#!create-network-appliance-vlan - networkId (string): (required) - id (string): The VLAN ID of the new VLAN (must be between 1 and 4094) - name (string): The name of the new VLAN - subnet (string): The subnet of the VLAN - applianceIp (string): The local IP of the appliance on the VLAN - groupPolicyId (string): The id of the desired group policy to apply to the VLAN """ kwargs.update(locals()) metadata = { 'tags': ['appliance', 'configure', 'vlans'], 'operation': 'createNetworkApplianceVlan' } resource = f'/networks/{networkId}/appliance/vlans' body_params = ['id', 'name', 'subnet', 'applianceIp', 'groupPolicyId', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "create", "body": payload } return action def updateNetworkApplianceVlansSettings(self, networkId: str, **kwargs): """ **Enable/Disable VLANs for the given network** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-vlans-settings - networkId (string): (required) - vlansEnabled (boolean): Boolean indicating whether to enable (true) or disable (false) VLANs for the network """ kwargs.update(locals()) metadata = { 'tags': ['appliance', 'configure', 'vlans', 'settings'], 'operation': 'updateNetworkApplianceVlansSettings' } resource = f'/networks/{networkId}/appliance/vlans/settings' body_params = ['vlansEnabled', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def updateNetworkApplianceVlan(self, networkId: str, vlanId: str, **kwargs): """ **Update a VLAN** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-vlan - networkId (string): (required) - vlanId (string): (required) - name (string): The name of the VLAN - subnet (string): The subnet of the VLAN - applianceIp (string): The local IP of the appliance on the VLAN - groupPolicyId (string): The id of the desired group policy to apply to the VLAN - vpnNatSubnet (string): The translated VPN subnet if VPN and VPN subnet translation are enabled on the VLAN - dhcpHandling (string): 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' - dhcpRelayServerIps (array): The IPs of the DHCP servers that DHCP requests should be relayed to - dhcpLeaseTime (string): 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' - dhcpBootOptionsEnabled (boolean): Use DHCP boot options specified in other properties - dhcpBootNextServer (string): DHCP boot option to direct boot clients to the server to load the boot file from - dhcpBootFilename (string): DHCP boot option for boot filename - fixedIpAssignments (object): 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. - reservedIpRanges (array): The DHCP reserved IP ranges on the VLAN - dnsNameservers (string): The DNS nameservers used for DHCP responses, either "upstream_dns", "google_dns", "opendns", or a newline seperated string of IP addresses or domain names - dhcpOptions (array): The list of DHCP options that will be included in DHCP responses. Each object in the list should have "code", "type", and "value" properties. """ kwargs.update(locals()) if 'dhcpHandling' in kwargs: options = ['Run a DHCP server', 'Relay DHCP to another server', 'Do not respond to DHCP requests'] assert kwargs['dhcpHandling'] in options, f'''"dhcpHandling" cannot be "{kwargs['dhcpHandling']}", & must be set to one of: {options}''' if 'dhcpLeaseTime' in kwargs: options = ['30 minutes', '1 hour', '4 hours', '12 hours', '1 day', '1 week'] assert kwargs['dhcpLeaseTime'] in options, f'''"dhcpLeaseTime" cannot be "{kwargs['dhcpLeaseTime']}", & must be set to one of: {options}''' metadata = { 'tags': ['appliance', 'configure', 'vlans'], 'operation': 'updateNetworkApplianceVlan' } resource = f'/networks/{networkId}/appliance/vlans/{vlanId}' body_params = ['name', 'subnet', 'applianceIp', 'groupPolicyId', 'vpnNatSubnet', 'dhcpHandling', 'dhcpRelayServerIps', 'dhcpLeaseTime', 'dhcpBootOptionsEnabled', 'dhcpBootNextServer', 'dhcpBootFilename', 'fixedIpAssignments', 'reservedIpRanges', 'dnsNameservers', 'dhcpOptions', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def deleteNetworkApplianceVlan(self, networkId: str, vlanId: str): """ **Delete a VLAN from a network** https://developer.cisco.com/meraki/api-v1/#!delete-network-appliance-vlan - networkId (string): (required) - vlanId (string): (required) """ metadata = { 'tags': ['appliance', 'configure', 'vlans'], 'operation': 'deleteNetworkApplianceVlan' } resource = f'/networks/{networkId}/appliance/vlans/{vlanId}' action = { "resource": resource, "operation": "destroy", "body": payload } return action def updateNetworkApplianceVpnBgp(self, networkId: str, enabled: bool, **kwargs): """ **Update a Hub BGP Configuration** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-vpn-bgp - networkId (string): (required) - enabled (boolean): 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. - asNumber (integer): 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. - ibgpHoldTimer (integer): 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. - neighbors (array): List of BGP neighbors. This list replaces the existing set of neighbors. When absent, this field is not updated. """ kwargs.update(locals()) metadata = { 'tags': ['appliance', 'configure', 'vpn', 'bgp'], 'operation': 'updateNetworkApplianceVpnBgp' } resource = f'/networks/{networkId}/appliance/vpn/bgp' body_params = ['enabled', 'asNumber', 'ibgpHoldTimer', 'neighbors', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def updateNetworkApplianceVpnSiteToSiteVpn(self, networkId: str, mode: str, **kwargs): """ **Update the site-to-site VPN settings of a network** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-vpn-site-to-site-vpn - networkId (string): (required) - mode (string): The site-to-site VPN mode. Can be one of 'none', 'spoke' or 'hub' - hubs (array): The list of VPN hubs, in order of preference. In spoke mode, at least 1 hub is required. - subnets (array): The list of subnets and their VPN presence. """ kwargs.update(locals()) if 'mode' in kwargs: options = ['none', 'spoke', 'hub'] assert kwargs['mode'] in options, f'''"mode" cannot be "{kwargs['mode']}", & must be set to one of: {options}''' metadata = { 'tags': ['appliance', 'configure', 'vpn', 'siteToSiteVpn'], 'operation': 'updateNetworkApplianceVpnSiteToSiteVpn' } resource = f'/networks/{networkId}/appliance/vpn/siteToSiteVpn' body_params = ['mode', 'hubs', 'subnets', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def updateNetworkApplianceWarmSpare(self, networkId: str, enabled: bool, **kwargs): """ **Update MX warm spare settings** https://developer.cisco.com/meraki/api-v1/#!update-network-appliance-warm-spare - networkId (string): (required) - enabled (boolean): Enable warm spare - spareSerial (string): Serial number of the warm spare appliance - uplinkMode (string): Uplink mode, either virtual or public - virtualIp1 (string): The WAN 1 shared IP - virtualIp2 (string): The WAN 2 shared IP """ kwargs.update(locals()) metadata = { 'tags': ['appliance', 'configure', 'warmSpare'], 'operation': 'updateNetworkApplianceWarmSpare' } resource = f'/networks/{networkId}/appliance/warmSpare' body_params = ['enabled', 'spareSerial', 'uplinkMode', 'virtualIp1', 'virtualIp2', ] payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params} action = { "resource": resource, "operation": "update", "body": payload } return action def swapNetworkApplianceWarmSpare(self, networkId: str): """ **Swap MX primary and warm spare appliances** https://developer.cisco.com/meraki/api-v1/#!swap-network-appliance-warm-spare - networkId (string): (required) """ metadata = { 'tags': ['appliance', 'configure', 'warmSpare'], 'operation': 'swapNetworkApplianceWarmSpare' } resource = f'/networks/{networkId}/appliance/warmSpare/swap' action = { "resource": resource, "operation": "create", "body": payload } return action