Interface IOrganizationsNetworks

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

I Organizations Networks

public interface IOrganizationsNetworks

Extension Methods

IOrganizationsNetworksExtensions.GetOrganizationNetworksAllAsync(IOrganizationsNetworks, string, string?, List<string>?, string?, List<ProductType>?, CancellationToken)

Methods

CombineOrganizationNetworksAsync(string, CombineOrganizationNetworksRequest, CancellationToken)

Combine multiple networks into a single network

[Post("/organizations/{organizationId}/networks/combine")]
Task<CombineNetworkResponse> CombineOrganizationNetworksAsync(string organizationId, CombineOrganizationNetworksRequest combineOrganizationNetworks, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

combineOrganizationNetworks CombineOrganizationNetworksRequest

Body for combining networks

cancellationToken CancellationToken

Returns

Task<CombineNetworkResponse>

Exceptions

ApiException

Thrown when fails to make API cg

CreateNetworkMoveAsync(string, NetworkMoveRequest, CancellationToken)

Move networks from one organization to another. Note that as this is an Early Access feature it may result in unexpected behavior and is best tested with non-critical networks. For more information and caveats around network move limitations see Network Portability

[Post("/organizations/{organizationId}/networks/moves")]
Task<NetworkMove> CreateNetworkMoveAsync(string organizationId, NetworkMoveRequest networkMoveRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

networkMoveRequest NetworkMoveRequest

cancellationToken CancellationToken

Returns

Task<NetworkMove>

Exceptions

ApiException

Thrown when fails to make API call

CreateOrganizationNetworkAsync(string, NetworkCreationRequest, CancellationToken)

Create a network

[Post("/organizations/{organizationId}/networks")]
Task<Network> CreateOrganizationNetworkAsync(string organizationId, NetworkCreationRequest createOrganizationNetwork, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

createOrganizationNetwork NetworkCreationRequest

Body for creating a network

cancellationToken CancellationToken

Returns

Task<Network>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkMoveAsync(string, string, CancellationToken)

Return details on the specified network move operation

[Get("/organizations/{organizationId}/networks/moves/{networkMoveId}")]
Task<NetworkMoveDetailed> GetNetworkMoveAsync(string organizationId, string networkMoveId, CancellationToken cancellationToken = default)

Parameters

organizationId string

networkMoveId string

cancellationToken CancellationToken

Returns

Task<NetworkMoveDetailed>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkMovesAsync(string, CancellationToken)

Return a list of network move operations in the organization

[Get("/organizations/{organizationId}/networks/moves")]
Task<List<NetworkMoveDetailed>> GetNetworkMovesAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

cancellationToken CancellationToken

Returns

Task<List<NetworkMoveDetailed>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationNetworksAsync(string, string?, List<string>?, string?, List<ProductType>?, int?, string?, string?, CancellationToken)

Get paged networks that the user has privileges on in an organization

[Get("/organizations/{organizationId}/networks")]
Task<List<Network>> GetOrganizationNetworksAsync(string organizationId, string? configTemplateId = null, List<string>? tags = null, string? tagsFilterType = null, List<ProductType>? productTypes = null, int? perPage = 100000, string? startingAfter = null, string? endingBefore = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

configTemplateId string

An optional parameter that is the ID of a config template. Will return all networks bound to that template. (optional)

tags List<string>

An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).

tagsFilterType string

An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

productTypes List<ProductType>

An optional parameter to filter networks by product type. Results will have at least one of the included product types.

perPage int?

The number of entries per page returned. Acceptable range is 3 - 100000. 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.

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<List<Network>>

Exceptions

ApiException

Thrown when fails to make API call