Skip to content

Install-WinCNIPlugin.md

Latest commit

 

History

History
168 lines (121 loc) · 3.3 KB

Install-WinCNIPlugin.md

File metadata and controls

168 lines (121 loc) · 3.3 KB
Raw

external help file: containers-toolkit-help.xml Module Name: containers-toolkit online version: schema: 2.0.0

Install-WinCNIPlugin

SYNOPSIS

Downloads and installs CNI plugin.

SYNTAX

Install-WinCNIPlugin [[-WinCNIVersion] <String>] [[-WinCNIPath] <String>] [-SourceRepo <String>]
 [-OSArchitecture <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Downloads CNI plugin from microsoft/windows-container-networking or containernetworking/plugin and installs it in the specified location.

EXAMPLES

Example 1: Using defaults

Installs latest Windows CNI plugin at the default path.

PS C:\> Install-WinCNIPlugin

Example 2: Using custom values

Installs Windows CNI plugin version 0.2.0 in the default path.

PS C:\> Install-WinCNIPlugin -WinCNIVersion "0.2.0"

PARAMETERS

-Force

Force CNI plugins uninstallation (if it exists) without any confirmation prompts.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-OSArchitecture

OS architecture to download files for. Default is $env:PROCESSOR_ARCHITECTURE

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $env:PROCESSOR_ARCHITECTURE
Accept pipeline input: False
Accept wildcard characters: False

-SourceRepo

Source of the Windows CNI plugins. Defaults to 'microsoft/windows-container-networking'

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: "microsoft/windows-container-networking"
Accept pipeline input: False
Accept wildcard characters: False

-WinCNIPath

Location to install Windows CNI.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: $Env:ProgramFiles\Containerd
Accept pipeline input: False
Accept wildcard characters: False

-WinCNIVersion

Windows CNI plugin version to use. Defaults to latest version.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: latest
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

RELATED LINKS