Interface INetworksFirmwareUpgrades

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

I Networks Firmware Upgrades

public interface INetworksFirmwareUpgrades

Methods

CreateNetworkFirmwareUpgradesRollbackAsync(string, FirmwareUpgradeRollbackRequest, CancellationToken)

Rollback a Firmware Upgrade For A Network

[Post("/networks/{networkId}/firmwareUpgrades/rollbacks")]
Task<NetworkFirmwareUpgrade> CreateNetworkFirmwareUpgradesRollbackAsync(string networkId, FirmwareUpgradeRollbackRequest createNetworkFirmwareUpgradesRollback, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

createNetworkFirmwareUpgradesRollback FirmwareUpgradeRollbackRequest

Body for creating network firmware upgrade rollbacks

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<NetworkFirmwareUpgrade>

Exceptions

ApiException

Thrown when fails to make API call

CreateNetworkFirmwareUpgradesStagedEventsAsync(string, NetworkFirmwareUpgradeStagedEventsCreateRequest, CancellationToken)

Create a Staged Upgrade Event for a Network

[Post("/networks/{networkId}/firmwareUpgrades/staged/events")]
Task<NetworkFirmwareUpgradeStagedEvents> CreateNetworkFirmwareUpgradesStagedEventsAsync(string networkId, NetworkFirmwareUpgradeStagedEventsCreateRequest createNetworkFirmwareUpgradesStagedEvents, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

createNetworkFirmwareUpgradesStagedEvents NetworkFirmwareUpgradeStagedEventsCreateRequest

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<NetworkFirmwareUpgradeStagedEvents>

Exceptions

ApiException

Thrown when fails to make API call

CreateNetworkFirmwareUpgradesStagedGroupsAsync(string, NetworkFirmwareUpgradesStagedGroupCreateRequest, CancellationToken)

Create a Staged Upgrade Group for a Network

[Post("/networks/{networkId}/firmwareUpgrades/staged/groups")]
Task<NetworkFirmwareUpgradesStagedGroup> CreateNetworkFirmwareUpgradesStagedGroupsAsync(string networkId, NetworkFirmwareUpgradesStagedGroupCreateRequest createNetworkFirmwareUpgradesStagedGroups, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

createNetworkFirmwareUpgradesStagedGroups NetworkFirmwareUpgradesStagedGroupCreateRequest

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<NetworkFirmwareUpgradesStagedGroup>

Exceptions

ApiException

Thrown when fails to make API call

DeferNetworkFirmwareUpgradesStagedEventsAsync(string, CancellationToken)

Postpone by 1 week all pending staged upgrade stages for a network

[Post("/networks/{networkId}/firmwareUpgrades/staged/events/defer")]
Task<NetworkFirmwareUpgradeStagedEventsDeferResponse> DeferNetworkFirmwareUpgradesStagedEventsAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<NetworkFirmwareUpgradeStagedEventsDeferResponse>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkFirmwareUpgradesStagedGroupsAsync(string, string, CancellationToken)

Delete a Staged Upgrade Group

[Delete("/networks/{networkId}/firmwareUpgrades/staged/groups/{groupId}")]
Task DeleteNetworkFirmwareUpgradesStagedGroupsAsync(string networkId, string groupId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

groupId string

cancellationToken CancellationToken

The Cancellation Token

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkFirmwareUpgradesAsync(string, CancellationToken)

Get firmware upgrade information for a network

[Get("/networks/{networkId}/firmwareUpgrades")]
Task<NetworkFirmwareUpgrade> GetNetworkFirmwareUpgradesAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<NetworkFirmwareUpgrade>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkFirmwareUpgradesStagedEventsAsync(string, CancellationToken)

Get the staged Upgrade events for a Network

[Get("/networks/{networkId}/firmwareUpgrades/staged/events")]
Task<NetworkFirmwareUpgradeStagedEvents> GetNetworkFirmwareUpgradesStagedEventsAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<NetworkFirmwareUpgradeStagedEvents>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkFirmwareUpgradesStagedGroupAsync(string, string, CancellationToken)

Get a Staged Upgrade Group from a Network

[Get("/networks/{networkId}/firmwareUpgrades/staged/groups/{groupId}")]
Task<NetworkFirmwareUpgradesStagedGroup> GetNetworkFirmwareUpgradesStagedGroupAsync(string networkId, string groupId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

groupId string

Group ID

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<NetworkFirmwareUpgradesStagedGroup>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkFirmwareUpgradesStagedGroupsAsync(string, CancellationToken)

List of Staged Upgrade Groups in a Network

[Get("/networks/{networkId}/firmwareUpgrades/staged/groups")]
Task<List<NetworkFirmwareUpgradesStagedGroup>> GetNetworkFirmwareUpgradesStagedGroupsAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<List<NetworkFirmwareUpgradesStagedGroup>>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkFirmwareUpgradesStagedStagesAsync(string, CancellationToken)

Order of Staged Upgrade Groups in a network

[Get("/networks/{networkId}/firmwareUpgrades/staged/stages")]
Task<List<NetworkFirmwareUpgradesStagedStage>> GetNetworkFirmwareUpgradesStagedStagesAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<List<NetworkFirmwareUpgradesStagedStage>>

Exceptions

ApiException

Thrown when fails to make API call

RollbacksNetworkFirmwareUpgradesStagedEventsAsync(string, NetworkFirmwareUpgradeStagedEventsRollbacksRequest, CancellationToken)

Rollback a Staged Upgrade Event for a Network

[Post("/networks/{networkId}/firmwareUpgrades/staged/events/rollbacks")]
Task<NetworkFirmwareUpgradeStagedEventsRollbacksResponse> RollbacksNetworkFirmwareUpgradesStagedEventsAsync(string networkId, NetworkFirmwareUpgradeStagedEventsRollbacksRequest createNetworkFirmwareUpgradesStagedEvents, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

createNetworkFirmwareUpgradesStagedEvents NetworkFirmwareUpgradeStagedEventsRollbacksRequest

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<NetworkFirmwareUpgradeStagedEventsRollbacksResponse>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkFirmwareUpgradesAsync(string, NetworkFirmwareUpgradeUpdateRequest, CancellationToken)

Update firmware upgrade information for a network

[Put("/networks/{networkId}/firmwareUpgrades")]
Task<NetworkFirmwareUpgrade> UpdateNetworkFirmwareUpgradesAsync(string networkId, NetworkFirmwareUpgradeUpdateRequest updateNetworkFirmwareUpgrades, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

updateNetworkFirmwareUpgrades NetworkFirmwareUpgradeUpdateRequest

Body for updating network firmware upgrades

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<NetworkFirmwareUpgrade>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkFirmwareUpgradesStagedEventsAsync(string, NetworkFirmwareUpgradeStagedEventsUpdateRequest, CancellationToken)

Update the Staged Upgrade Event for a network

[Put("/networks/{networkId}/firmwareUpgrades/staged/events")]
Task<NetworkFirmwareUpgradeStagedEvents> UpdateNetworkFirmwareUpgradesStagedEventsAsync(string networkId, NetworkFirmwareUpgradeStagedEventsUpdateRequest createNetworkFirmwareUpgradesStagedEvents, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

createNetworkFirmwareUpgradesStagedEvents NetworkFirmwareUpgradeStagedEventsUpdateRequest

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<NetworkFirmwareUpgradeStagedEvents>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkFirmwareUpgradesStagedGroupsAsync(string, string, NetworkFirmwareUpgradesStagedGroupUpdateRequest, CancellationToken)

Update a Staged Upgrade Group for a network

[Put("/networks/{networkId}/firmwareUpgrades/staged/groups/{groupId}")]
Task<NetworkFirmwareUpgradesStagedGroupUpdateResponse> UpdateNetworkFirmwareUpgradesStagedGroupsAsync(string networkId, string groupId, NetworkFirmwareUpgradesStagedGroupUpdateRequest createNetworkFirmwareUpgradesStagedGroups, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

groupId string

createNetworkFirmwareUpgradesStagedGroups NetworkFirmwareUpgradesStagedGroupUpdateRequest

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<NetworkFirmwareUpgradesStagedGroupUpdateResponse>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkFirmwareUpgradesStagedStagesAsync(string, NetworkFirmwareUpgradesStagedStageUpdateRequest, CancellationToken)

Assign Staged Upgrade Group order in the sequence.

[Put("/networks/{networkId}/firmwareUpgrades/staged/stages")]
Task<NetworkFirmwareUpgradesStagedStage> UpdateNetworkFirmwareUpgradesStagedStagesAsync(string networkId, NetworkFirmwareUpgradesStagedStageUpdateRequest updateNetworkFirmwareUpgradesStagedStages, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

updateNetworkFirmwareUpgradesStagedStages NetworkFirmwareUpgradesStagedStageUpdateRequest

cancellationToken CancellationToken

The Cancellation Token

Returns

Task<NetworkFirmwareUpgradesStagedStage>

Exceptions

ApiException

Thrown when fails to make API call