Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 43 additions & 7 deletions Docs/Commands/Set-YubikeyOTP.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ online version:
schema: 2.0.0
---

# Set-YubikeyOTP
# Set-YubiKeyOTP

## SYNOPSIS
Configure OTP slots
Expand All @@ -14,28 +14,34 @@ Configure OTP slots

### Yubico OTP
```
Set-YubikeyOTP -Slot <Slot> [-YubicoOTP] [-PublicID <Byte[]>] [-PrivateID <Byte[]>] [-SecretKey <Byte[]>]
Set-YubiKeyOTP -Slot <Slot> [-YubicoOTP] [-PublicID <Byte[]>] [-PrivateID <Byte[]>] [-SecretKey <Byte[]>]
[-Upload] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### Static Password
```
Set-YubikeyOTP -Slot <Slot> [-StaticPassword] -Password <SecureString> [-KeyboardLayout <KeyboardLayout>]
Set-YubiKeyOTP -Slot <Slot> [-StaticPassword] -Password <SecureString> [-KeyboardLayout <KeyboardLayout>]
[-AppendCarriageReturn] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### Static Generated Password
```
Set-YubikeyOTP -Slot <Slot> [-StaticGeneratedPassword] -PasswordLength <Int32>
Set-YubiKeyOTP -Slot <Slot> [-StaticGeneratedPassword] -PasswordLength <Int32>
[-KeyboardLayout <KeyboardLayout>] [-AppendCarriageReturn] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### ChallengeResponse
```
Set-YubikeyOTP -Slot <Slot> [-ChallengeResponse] [-SecretKey <Byte[]>]
Set-YubiKeyOTP -Slot <Slot> [-ChallengeResponse] [-SecretKey <Byte[]>]
[-Algorithm <ChallengeResponseAlgorithm>] [-RequireTouch] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### HOTP
```
Set-YubiKeyOTP -Slot <Slot> [-SecretKey <Byte[]>] [-AppendCarriageReturn] [-HOTP] [-Base32Secret <String>]
[-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Allows the configuration of the YubiKey OTP slots (2). The YubiKey OTP slots can be configured with:

Expand Down Expand Up @@ -105,7 +111,22 @@ field and "pressing Enter" on behalf of the user.

```yaml
Type: SwitchParameter
Parameter Sets: Static Password, Static Generated Password
Parameter Sets: Static Password, Static Generated Password, HOTP
Aliases:

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

### -Base32Secret
Base32 encoded secret key for HOTP

```yaml
Type: String
Parameter Sets: HOTP
Aliases:

Required: False
Expand All @@ -130,6 +151,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -HOTP
Allows configuration of HOTP mode

```yaml
Type: SwitchParameter
Parameter Sets: HOTP
Aliases:

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

### -KeyboardLayout
Keyboard layout to be used.

Expand Down Expand Up @@ -226,7 +262,7 @@ Sets the Secret Key, defaults to random 16 bytes.

```yaml
Type: Byte[]
Parameter Sets: Yubico OTP, ChallengeResponse
Parameter Sets: Yubico OTP, ChallengeResponse, HOTP
Aliases:

Required: False
Expand Down
Loading
Loading