Interface ISwitchProfiles

Namespace

Meraki.Api.Interfaces.Products.Switch

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface ISwitchProfiles

Methods

GetOrganizationConfigTemplateSwitchProfilePortAsync(string, string, string, string, CancellationToken)

Return a switch template port

[Get("/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}")]
Task<ConfigTemplateSwitchProfilePort> GetOrganizationConfigTemplateSwitchProfilePortAsync(string organizationId, string configTemplateId, string profileId, string portId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

configTemplateId string

The configuration id

profileId string

The profile id

portId string

The port id

cancellationToken CancellationToken

Returns

Task<ConfigTemplateSwitchProfilePort>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationConfigTemplateSwitchProfilePortsAsync(string, string, string, CancellationToken)

Return all the templates of a switch profile

[Get("/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports")]
Task<List<ConfigTemplateSwitchProfilePort>> GetOrganizationConfigTemplateSwitchProfilePortsAsync(string organizationId, string configTemplateId, string profileId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

configTemplateId string

The configuration id

profileId string

The profile id

cancellationToken CancellationToken

Returns

Task<List<ConfigTemplateSwitchProfilePort>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationConfigTemplateSwitchProfilesAsync(string, string, CancellationToken)

List the switch templates for your switch template configuration

[Get("/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles")]
Task<List<SwitchProfile>> GetOrganizationConfigTemplateSwitchProfilesAsync(string organizationId, string configTemplateId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

configTemplateId string

The configuration id

cancellationToken CancellationToken

Returns

Task<List<SwitchProfile>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationConfigTemplateSwitchProfilePortAsync(string, string, string, string, ConfigTemplateSwitchProfilePort, CancellationToken)

Update a switch template port

[Put("/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}")]
Task<ConfigTemplateSwitchProfilePort> UpdateOrganizationConfigTemplateSwitchProfilePortAsync(string organizationId, string configTemplateId, string profileId, string portId, ConfigTemplateSwitchProfilePort updateOrganizationConfigTemplateSwitchProfilePort, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

configTemplateId string

The configuration id

profileId string

The profile id

portId string

The port id

updateOrganizationConfigTemplateSwitchProfilePort ConfigTemplateSwitchProfilePort

cancellationToken CancellationToken

Returns

Task<ConfigTemplateSwitchProfilePort>

Exceptions

ApiException

Thrown when fails to make API call