configure keychain add key

configure keychain keychain_name add key key_id key-string [text_string {active-lifetime {local} start start_time [end end_time | [duration [seconds | maximum]]]} | encrypted encrypted_string]


This command configures a key to add to a keychain.

Syntax Description

keychain_name Specifies the name of the keychain.
add Specifies adding a key to the keychain.
key Authentication key entry.
key_id Specifies the unique identifier within a keychain. Range is 1-65535.
key-string Specifies the shared secret text string for the key.
text_string Specifies the string. Range is 1-127.
active-lifetime Specifies the time period the key will be active.
local Specifies the time in the local time zone instead of UTC.
start Specifies the start of the time period.
start_time Specifies the date and time the key will become active. Format is YYYY-MM-DDThh:mm:ss.
end Specifies the end of the time period.
end_time Specifies the date and time the key will stop being active. Format is YYYY-MM-DDThh:mm:ss.
duration Specifies the length of time the key will be active.
seconds Specifies the duration in seconds. Range is 1-15552000.
maximum Specifies that the key will be active for 180 days from the start time.
encrypted Specifies the key string in encrypted form.
encrypted_string Specifies the encrypted string.



Usage Guidelines

A maximum of 8 keys can be added to a keychain.

The maximum length of a key string is 127 characters.

The maximum validity period of a key is 180 days.


The following command configures the keychain to add an OSPFv3 key:

create keychain ospfv3-keys1

The following command adds a key string to the keychain:

configure keychain ospfv3-keys1 add key 3 key-string auth3 

The following command adds additional options to the keychain:

configure keychain ospfv3-keys1 add key 1 key-string auth1 active-lifetime local start 2021-06-01T00:00:00 end 2021-07-01T00:00:00


This command was first available in ExtremeXOS 31.3.

Platform Availability

This command is available on ExtremeSwitching X435, X440-G2, X450-G2, X460-G2, X465, X590, X620, X670-G2, X690, X695, X870, 5320, 5420, and 5520 series switches.