Interface INetworksGroupPolicies

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

public interface INetworksGroupPolicies

Methods

CreateNetworkGroupPolicyAsync(string, GroupPolicy, CancellationToken)

Create a group policy

[Post("/networks/{networkId}/groupPolicies")]
Task<GroupPolicy> CreateNetworkGroupPolicyAsync(string networkId, GroupPolicy createNetworkGroupPolicy, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

createNetworkGroupPolicy GroupPolicy

Body for creating a network group policy

cancellationToken CancellationToken

Returns

Task<GroupPolicy>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkGroupPolicyAsync(string, string, bool?, CancellationToken)

Delete a group policy

[Delete("/networks/{networkId}/groupPolicies/{groupPolicyId}")]
Task DeleteNetworkGroupPolicyAsync(string networkId, string groupPolicyId, bool? force, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

groupPolicyId string

The group policy id

force bool?

If true, the system deletes the GP even if there are active clients using the GP. After deletion, active clients that were assigned to that Group Policy will be left without any policy applied. Default is false.

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkGroupPoliciesAsync(string, CancellationToken)

List the group policies in a network

[Get("/networks/{networkId}/groupPolicies")]
Task<List<GroupPolicy>> GetNetworkGroupPoliciesAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<GroupPolicy>>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkGroupPolicyAsync(string, string, CancellationToken)

Display a group policy

[Get("/networks/{networkId}/groupPolicies/{groupPolicyId}")]
Task<GroupPolicy> GetNetworkGroupPolicyAsync(string networkId, string groupPolicyId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

groupPolicyId string

The group policy id

cancellationToken CancellationToken

Returns

Task<GroupPolicy>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkGroupPolicyAsync(string, string, GroupPolicy, CancellationToken)

Update a group policy

[Put("/networks/{networkId}/groupPolicies/{groupPolicyId}")]
Task<GroupPolicy> UpdateNetworkGroupPolicyAsync(string networkId, string groupPolicyId, GroupPolicy updateNetworkGroupPolicy, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

groupPolicyId string

updateNetworkGroupPolicy GroupPolicy

Body for updating a network group policy

cancellationToken CancellationToken

Returns

Task<GroupPolicy>

Exceptions

ApiException

Thrown when fails to make API call