Interface INetworksVlanProfiles

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

public interface INetworksVlanProfiles

Extension Methods

INetworksVlanProfilesExtensions.GetNetworkVlanProfilesAssignmentsByDeviceAllAsync(INetworksVlanProfiles, string, List<string>?, List<string>?, List<string>?, CancellationToken)

Methods

CreateNetworkVlanProfileAsync(string, VlanProfileCreateRequest, CancellationToken)

Create a Vlan profile on a network

[Post("/networks/{networkId}/vlanProfiles")]
Task<VlanProfile> CreateNetworkVlanProfileAsync(string networkId, VlanProfileCreateRequest vlanProfileCreateRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

vlanProfileCreateRequest VlanProfileCreateRequest

The vlan profile creation request

cancellationToken CancellationToken

Returns

Task<VlanProfile>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkVlanProfileAsync(string, string, CancellationToken)

Delete a VLAN profile of a network

[Delete("/networks/{networkId}/vlanProfiles/{iname}")]
Task DeleteNetworkVlanProfileAsync(string networkId, string iname, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

iname string

The iname for the Vlan profile to delete

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkVlanProfileAsync(string, string, CancellationToken)

Get an existing VLAN profile of a network

[Get("/networks/{networkId}/vlanProfiles/{iname}")]
Task<VlanProfile> GetNetworkVlanProfileAsync(string networkId, string iname, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

iname string

The iname for the Vlan profile

cancellationToken CancellationToken

Returns

Task<VlanProfile>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkVlanProfilesAssignmentsByDeviceAsync(string, int?, string?, string?, List<string>?, List<string>?, List<string>?, CancellationToken)

Get the assigned VLAN Profiles for devices in a network

[Get("/networks/{networkId}/vlanProfiles/assignments/byDevice")]
Task<List<VlanProfileDeviceAssignment>> GetNetworkVlanProfilesAssignmentsByDeviceAsync(string networkId, int? perPage = 1000, string? startingAfter = null, string? endingBefore = null, List<string>? serials = null, List<string>? productTypes = null, List<string>? stackIds = null, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

perPage int?

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

startingAfter string

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.

endingBefore string

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.

serials List<string>

Optional parameter to filter devices by serials. All devices returned belong to serial numbers that are an exact match.

productTypes List<string>

Optional parameter to filter devices by product types.

stackIds List<string>

Optional parameter to filter devices by Switch Stack ids.

cancellationToken CancellationToken

Returns

Task<List<VlanProfileDeviceAssignment>>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkVlanProfilesAsync(string, CancellationToken)

List VLAN profiles for a network

[Get("/networks/{networkId}/vlanProfiles")]
Task<List<VlanProfile>> GetNetworkVlanProfilesAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<VlanProfile>>

Exceptions

ApiException

Thrown when fails to make API call

ReassignNetworkVlanProfilesAssignmentsAsync(string, VlanProfileReassignmentRequest, CancellationToken)

Update the assigned VLAN Profile for devices in a network

[Post("/networks/{networkId}/vlanProfiles/assignments/reassign")]
Task<VlanProfileAssignment> ReassignNetworkVlanProfilesAssignmentsAsync(string networkId, VlanProfileReassignmentRequest vlanProfileReassignmentRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

vlanProfileReassignmentRequest VlanProfileReassignmentRequest

The vlan profile reassignment request

cancellationToken CancellationToken

Returns

Task<VlanProfileAssignment>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkVlanProfileAsync(string, string, VlanProfileUpdateRequest, CancellationToken)

Update an existing VLAN profile of a network

[Put("/networks/{networkId}/vlanProfiles/{iname}")]
Task<VlanProfile> UpdateNetworkVlanProfileAsync(string networkId, string iname, VlanProfileUpdateRequest vlanProfileUpdateRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

iname string

The iname for the Vlan profile

vlanProfileUpdateRequest VlanProfileUpdateRequest

The vlan profile update request

cancellationToken CancellationToken

Returns

Task<VlanProfile>

Exceptions

ApiException

Thrown when fails to make API call