Cellular Gateway

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.

Returns:

• OrganizationCellularGatewayEsimsServiceProvidersAccountResponse –

  Successful operation.

{
  "accountId": "0987654321",
  "lastUpdatedAt": "2023-08-21T00:00:00Z",
  "serviceProvider": {
    "name": "ATT",
    "logo": {
      "url": "serviceproviderlogo.url"
    }
  },
  "title": "My AT&T account",
  "username": "MerakiUser"
}

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.

Returns:

• OrganizationCellularGatewayEsimsSwapResponse –

  Successful operation.

{
  "eid": "1234567890",
  "iccid": "9876543210",
  "status": "Completed"
}

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

API documentation: deleteOrganizationCellularGatewayEsimsServiceProvidersAccount

Parameters:

• organization_id (str) –

  Organization ID.

• account_id (str) –

  Account ID.

Returns:

• None –

  Successful operation.

Show the LAN Settings of a MG.

API documentation: getDeviceCellularGatewayLan

Parameters:

• serial (str) –

  Serial.

Returns:

• DeviceCellularGatewayLanResponse –

  Successful operation.

{
  "deviceName": "name of the MG",
  "deviceLanIp": "192.168.0.33",
  "deviceSubnet": "192.168.0.32/27",
  "fixedIpAssignments": [
    {
      "name": "server 1",
      "ip": "192.168.0.10",
      "mac": "0b:00:00:00:00:ac"
    }
  ],
  "reservedIpRanges": [
    {
      "start": "192.168.1.0",
      "end": "192.168.1.1",
      "comment": "A reserved IP range"
    }
  ]
}

Returns the port forwarding rules for a single MG.

API documentation: getDeviceCellularGatewayPortForwardingRules

Parameters:

• serial (str) –

  Serial.

Returns:

• DeviceCellularGatewayPortForwardingRulesResponse –

  Successful operation.

{
  "rules": [
    {
      "name": "test",
      "lanIp": "172.31.128.5",
      "publicPort": "11-12",
      "localPort": "4",
      "allowedIps": [
        "10.10.10.10",
        "10.10.10.11"
      ],
      "protocol": "tcp",
      "access": "any"
    }
  ]
}

Return the connectivity testing destinations for an MG network.

API documentation: getNetworkCellularGatewayConnectivityMonitoringDestinations

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkCellularGatewayConnectivityMonitoringDestinationsResponse –

  Successful operation.

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

List common DHCP settings of MGs.

API documentation: getNetworkCellularGatewayDhcp

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkCellularGatewayDhcpResponse –

  Successful operation.

{
  "dhcpLeaseTime": "1 hour",
  "dnsNameservers": "custom",
  "dnsCustomNameservers": [
    "172.16.2.111",
    "172.16.2.30"
  ]
}

Return the subnet pool and mask configured for MGs in the network.

API documentation: getNetworkCellularGatewaySubnetPool

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkCellularGatewaySubnetPoolResponse –

  Successful operation.

{
  "deploymentMode": "routed",
  "cidr": "192.168.0.0/16",
  "mask": 24,
  "subnets": [
    {
      "serial": "AAAA-AAAA-AAAA",
      "name": "my first MG",
      "applianceIp": "192.168.0.1",
      "subnet": "192.168.0.0/24"
    }
  ]
}

Returns the uplink settings for your MG network.

API documentation: getNetworkCellularGatewayUplink

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkCellularGatewayUplinkResponse –

  Successful operation.

{
  "bandwidthLimits": {
    "limitUp": 51200,
    "limitDown": 51200
  }
}

The eSIM inventory of a given organization.

API documentation: getOrganizationCellularGatewayEsimsInventory

Parameters:

• organization_id (str) –

  Organization ID.

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

  Optional parameter to filter the results by EID.

Returns:

• PaginatedResponse[UpdateOrganizationCellularGatewayEsimsInventoryResponse] –

  Successful operation.

{
  "items": [
    {
      "device": {
        "name": "My cellular gateway",
        "model": "mg52",
        "serial": "Q234-ABCD-5678",
        "url": "https://n1.meraki.com//n//manage/nodes/new_list/000000000000",
        "status": "online"
      },
      "active": true,
      "eid": "89000000000000000000000000000000",
      "lastUpdatedAt": "2023-02-01T00:00:00Z",
      "network": {
        "id": "N_24329156"
      },
      "profiles": [
        {
          "customApns": [
            "internet"
          ],
          "iccid": "8900000000000000000",
          "status": "activated",
          "serviceProvider": {
            "name": "ATT",
            "plans": [
              {
                "name": "1 Cisco IoT SDO AT&T eSIM Test Plan downloadable",
                "type": "communication"
              }
            ]
          }
        }
      ]
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 1,
        "remaining": 0
      }
    }
  }
}

Service providers customers can add accounts for.

API documentation: getOrganizationCellularGatewayEsimsServiceProviders

Parameters:

• organization_id (str) –

  Organization ID.

Returns:

• PaginatedResponse[GetOrganizationCellularGatewayEsimsServiceProvidersResponseItemsItem] –

  Successful operation.

{
  "items": [
    {
      "name": "AT&T",
      "logo": {
        "url": "Logo URL"
      },
      "isBootstrap": false,
      "terms": {
        "content": "Legal jargon",
        "name": "AT&T Terms and Conditions"
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 42,
        "remaining": 0
      }
    }
  }
}

Inventory of service provider accounts tied to the organization.

API documentation: getOrganizationCellularGatewayEsimsServiceProvidersAccounts

Parameters:

• organization_id (str) –

  Organization ID.

• account_ids (list[int] | None, default: None ) –

  Optional parameter to filter the results by service provider account IDs.

Returns:

• PaginatedResponse[OrganizationCellularGatewayEsimsServiceProvidersAccountResponse] –

  Successful operation.

[
  {
    "items": [
      {
        "accountId": "0987654321",
        "lastUpdatedAt": "2023-08-21T00:00:00Z",
        "serviceProvider": {
          "name": "ATT",
          "logo": {
            "url": "serviceproviderlogo.url"
          }
        },
        "title": "My AT&T account",
        "username": "MerakiUser"
      }
    ],
    "meta": {
      "counts": {
        "items": {
          "total": 1,
          "remaining": 0
        }
      }
    }
  }
]

The communication plans available for a given provider.

API documentation: getOrganizationCellularGatewayEsimsServiceProvidersAccountsCommunicationPlans

Parameters:

• organization_id (str) –

  Organization ID.

• account_ids (list[str]) –

  Account IDs that communication plans will be fetched for.

Returns:

• PaginatedResponse[GetOrganizationCellularGatewayEsimsServiceProvidersAccountsCommunicationPlansResponseItemsItem] –

  Successful operation.

{
  "items": [
    {
      "accountId": "some account ID",
      "apns": [
        {
          "name": "Some APN"
        }
      ],
      "name": "A communication plan"
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 2,
        "remaining": 0
      }
    }
  }
}

The rate plans available for a given provider.

API documentation: getOrganizationCellularGatewayEsimsServiceProvidersAccountsRatePlans

Parameters:

• organization_id (str) –

  Organization ID.

• account_ids (list[str]) –

  Account IDs that rate plans will be fetched for.

Returns:

• PaginatedResponse[GetOrganizationCellularGatewayEsimsServiceProvidersAccountsRatePlansResponseItemsItem] –

  Successful operation.

{
  "items": [
    {
      "accountId": "account ID",
      "name": "A rate plan"
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 2,
        "remaining": 0
      }
    }
  }
}

List the uplink status of every Meraki MG cellular gateway in the organization.

API documentation: getOrganizationCellularGatewayUplinkStatuses

Parameters:

• organization_id (str) –

  Organization ID.

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

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

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

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

  A list of network IDs. The returned devices will be filtered to only include these networks.

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

  A list of serial numbers. The returned devices will be filtered to only include these serials.

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

  A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs.

• 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[GetOrganizationCellularGatewayUplinkStatusesResponseItem] –

  Successful operation.

[
  {
    "networkId": "N_24329156",
    "serial": "Q234-ABCD-5678",
    "model": "MG21",
    "lastReportedAt": "2018-02-11T00:00:00Z",
    "uplinks": [
      {
        "interface": "cellular",
        "status": "ready",
        "ip": "1.2.3.4",
        "provider": "at&t",
        "publicIp": "123.123.123.1",
        "model": "integrated",
        "signalStat": {
          "rsrp": "-120",
          "rsrq": "-13"
        },
        "mcc": "123",
        "mnc": "123",
        "roaming": {
          "status": "home"
        },
        "connectionType": "4g",
        "apn": "internet",
        "gateway": "100.100.100.100",
        "dns1": "111.111.111.111",
        "dns2": "222.222.222.222",
        "signalType": "4G",
        "mtu": 1500,
        "iccid": "123456789",
        "imsi": "123456789012345",
        "msisdn": "123456789012345"
      }
    ]
  }
]

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.

Returns:

• DeviceCellularGatewayLanResponse –

  Successful operation.

{
  "deviceName": "name of the MG",
  "deviceLanIp": "192.168.0.33",
  "deviceSubnet": "192.168.0.32/27",
  "fixedIpAssignments": [
    {
      "name": "server 1",
      "ip": "192.168.0.10",
      "mac": "0b:00:00:00:00:ac"
    }
  ],
  "reservedIpRanges": [
    {
      "start": "192.168.1.0",
      "end": "192.168.1.1",
      "comment": "A reserved IP range"
    }
  ]
}

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.

Returns:

• DeviceCellularGatewayPortForwardingRulesResponse –

  Successful operation.

{
  "rules": [
    {
      "name": "test",
      "lanIp": "172.31.128.5",
      "publicPort": "11-12",
      "localPort": "4",
      "allowedIps": [
        "10.10.10.10",
        "10.10.10.11"
      ],
      "protocol": "tcp",
      "access": "any"
    }
  ]
}

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.

Returns:

• NetworkCellularGatewayConnectivityMonitoringDestinationsResponse –

  Successful operation.

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

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

Returns:

• NetworkCellularGatewayDhcpResponse –

  Successful operation.

{
  "dhcpLeaseTime": "1 hour",
  "dnsNameservers": "custom",
  "dnsCustomNameservers": [
    "172.16.2.111",
    "172.16.2.30"
  ]
}

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.

Returns:

• NetworkCellularGatewaySubnetPoolResponse –

  Successful operation.

{
  "deploymentMode": "routed",
  "cidr": "192.168.0.0/16",
  "mask": 24,
  "subnets": [
    {
      "serial": "AAAA-AAAA-AAAA",
      "name": "my first MG",
      "applianceIp": "192.168.0.1",
      "subnet": "192.168.0.0/24"
    }
  ]
}

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.

Returns:

• NetworkCellularGatewayUplinkResponse –

  Successful operation.

{
  "bandwidthLimits": {
    "limitUp": 51200,
    "limitDown": 51200
  }
}

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.

Returns:

• UpdateOrganizationCellularGatewayEsimsInventoryResponse –

  Successful operation.

{
  "device": {
    "name": "My cellular gateway",
    "model": "mg52",
    "serial": "Q234-ABCD-5678",
    "url": "https://n1.meraki.com//n//manage/nodes/new_list/000000000000",
    "status": "online"
  },
  "active": true,
  "eid": "89000000000000000000000000000000",
  "lastUpdatedAt": "2023-02-01T00:00:00Z",
  "network": {
    "id": "N_24329156"
  },
  "profiles": [
    {
      "customApns": [
        "internet"
      ],
      "iccid": "8900000000000000000",
      "status": "activated",
      "serviceProvider": {
        "name": "ATT",
        "plans": [
          {
            "name": "1 Cisco IoT SDO AT&T eSIM Test Plan downloadable",
            "type": "communication"
          }
        ]
      }
    }
  ]
}

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.

Returns:

• OrganizationCellularGatewayEsimsServiceProvidersAccountResponse –

  Successful operation.

{
  "accountId": "0987654321",
  "lastUpdatedAt": "2023-08-21T00:00:00Z",
  "serviceProvider": {
    "name": "ATT",
    "logo": {
      "url": "serviceproviderlogo.url"
    }
  },
  "title": "My AT&T account",
  "username": "MerakiUser"
}

Get the status of a profile swap.

API documentation: updateOrganizationCellularGatewayEsimsSwap

Parameters:

• id (str) –

  eSIM EID.

• organization_id (str) –

  Organization ID.

Returns:

• OrganizationCellularGatewayEsimsSwapResponse –

  Successful operation.

{
  "eid": "1234567890",
  "iccid": "9876543210",
  "status": "Completed"
}