Skip to content

CellularGateway (Batch)

ActionBatchCellularGateway

ActionBatchCellularGateway class.

create_organization_cellular_gateway_esims_service_providers_account

Add a service provider account.

API documentation: createOrganizationCellularGatewayEsimsServiceProvidersAccount

Parameters:

  • organization_id (str) –

    Organization ID.

  • account_id (str) –

    Service provider account ID.

  • api_key (str) –

    Service provider account API key.

  • service_provider (CreateOrganizationCellularGatewayEsimsServiceProvidersAccountServiceProvider) –

    Service Provider information.

  • title (str) –

    Service provider account name.

  • username (str) –

    Service provider account username.

create_organization_cellular_gateway_esims_swap

Swap which profile an eSIM uses.

API documentation: createOrganizationCellularGatewayEsimsSwap

Parameters:

  • organization_id (str) –

    Organization ID.

  • swaps (list[CreateOrganizationCellularGatewayEsimsSwapSwapsItem]) –

    Each object represents a swap for one eSIM.

delete_organization_cellular_gateway_esims_service_providers_account

Remove a service provider account's integration with the Dashboard.

API documentation: deleteOrganizationCellularGatewayEsimsServiceProvidersAccount

Parameters:

  • organization_id (str) –

    Organization ID.

  • account_id (str) –

    Account ID.

update_device_cellular_gateway_lan

Update the LAN Settings for a single MG.

API documentation: updateDeviceCellularGatewayLan

Parameters:

  • serial (str) –

    Serial.

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

    list of all reserved IP ranges for a single MG.

  • fixed_ip_assignments (list[UpdateDeviceCellularGatewayLanFixedIpAssignmentsItem] | None, default: None ) –

    list of all fixed IP assignments for a single MG.

update_device_cellular_gateway_port_forwarding_rules

Updates the port forwarding rules for a single MG.

API documentation: updateDeviceCellularGatewayPortForwardingRules

Parameters:

  • serial (str) –

    Serial.

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

    An array of port forwarding params.

update_network_cellular_gateway_connectivity_monitoring_destinations

Update the connectivity testing destinations for an MG network.

API documentation: updateNetworkCellularGatewayConnectivityMonitoringDestinations

Parameters:

  • network_id (str) –

    Network ID.

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

    The list of connectivity monitoring destinations.

update_network_cellular_gateway_dhcp

Update common DHCP settings of MGs.

API documentation: updateNetworkCellularGatewayDhcp

Parameters:

  • network_id (str) –

    Network ID.

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

    DHCP Lease time for all MG of the network. Possible values are '30 minutes', '1 hour', '4 hours', '12 hours', '1 day' or '1 week'.

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

    DNS name servers mode for all MG of the network. Possible values are: 'upstream_dns', 'google_dns', 'opendns', 'custom'.

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

    list of fixed IPs representing the the DNS Name servers when the mode is 'custom'.

update_network_cellular_gateway_subnet_pool

Update the subnet pool and mask configuration for MGs in the network.

API documentation: updateNetworkCellularGatewaySubnetPool

Parameters:

  • network_id (str) –

    Network ID.

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

    Mask used for the subnet of all MGs in this network.

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

    CIDR of the pool of subnets. Each MG in this network will automatically pick a subnet from this pool.

Updates the uplink settings for your MG network.

API documentation: updateNetworkCellularGatewayUplink

Parameters:

  • network_id (str) –

    Network ID.

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

    The bandwidth settings for the 'cellular' uplink.

update_organization_cellular_gateway_esims_inventory

Toggle the status of an eSIM.

API documentation: updateOrganizationCellularGatewayEsimsInventory

Parameters:

  • organization_id (str) –

    Organization ID.

  • id (str) –

    ID.

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

    Status the eSIM will be updated to.

update_organization_cellular_gateway_esims_service_providers_account

Edit service provider account info stored in Meraki's database.

API documentation: updateOrganizationCellularGatewayEsimsServiceProvidersAccount

Parameters:

  • organization_id (str) –

    Organization ID.

  • account_id (str) –

    Account ID.

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

    Service provider account name used on the Meraki UI.

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

    Service provider account API key.

update_organization_cellular_gateway_esims_swap

Get the status of a profile swap.

API documentation: updateOrganizationCellularGatewayEsimsSwap

Parameters:

  • id (str) –

    eSIM EID.

  • organization_id (str) –

    Organization ID.