Interface INetworksDevices

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

public interface INetworksDevices

Methods

ClaimNetworkDevicesAsync(string, bool, DeviceClaimRequest, CancellationToken)

Claim devices into a network.

[Post("/networks/{networkId}/devices/claim")]
Task ClaimNetworkDevicesAsync(string networkId, bool addAtomically, DeviceClaimRequest claimNetworkDevices, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

addAtomically bool

Whether to claim devices atomically. If true, all devices will be claimed or none will be claimed. Default is true.

claimNetworkDevices DeviceClaimRequest

Body for claiming a network device

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkDevicesAsync(string, CancellationToken)

List the devices in a network

[Get("/networks/{networkId}/devices")]
Task<List<Device>> GetNetworkDevicesAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<Device>>

Exceptions

ApiException

Thrown when fails to make API call

RemoveNetworkDevicesAsync(string, DeviceRemovalRequest, CancellationToken)

Remove a single device

[Post("/networks/{networkId}/devices/remove")]
Task RemoveNetworkDevicesAsync(string networkId, DeviceRemovalRequest deviceRemovalRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

deviceRemovalRequest DeviceRemovalRequest

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

VmxNetworkDevicesClaimAsync(string, VmxNetworkDevicesClaim, CancellationToken)

Claim a vMX into a network

[Post("/networks/{networkId}/devices/claim/vmx")]
Task<Device> VmxNetworkDevicesClaimAsync(string networkId, VmxNetworkDevicesClaim vmxNetworkDevicesClaim, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

vmxNetworkDevicesClaim VmxNetworkDevicesClaim

Body of request

cancellationToken CancellationToken

Returns

Task<Device>

Exceptions

ApiException

Thrown when fails to make API call