Skip to content

Latest commit

 

History

History
165 lines (119 loc) · 3.42 KB

Install-WinCNIPlugin.md

File metadata and controls

165 lines (119 loc) · 3.42 KB

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

Install-WinCNIPlugin

SYNOPSIS

Downloads and installs Windows CNI plugin.

SYNTAX

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

DESCRIPTION

Downloads Windows CNI plugin from windows-container-networking 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

-Confirm

Prompts for confirmation before running the cmdlet. For more information, see the following articles:

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Force

Installs Windows CNI plugins even if the tool already exists at the specified path.

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: Setup
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: "microsoft/windows-container-networking", "containernetworking/plugins"
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: Path where containerd is installed or `$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 version
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet isn't run.

Type: SwitchParameter
Parameter Sets: Setup
Aliases:

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

RELATED LINKS