Context
The context of v3-authentication within the schema tree is shown. Italicised links are to other pages.
deployment-config:snmp (in snmp-config.yaml) v3-authentication username authentication-protocol authentication-key authentication-key-id privacy-protocol privacy-key privacy-key-id
SNMPv3 authentication configuration. Only used when 'v3-enabled' is set to 'true'.
Conditional
This container is only valid when ../v3-enabled = 'true'.
authentication-protocol
The authentication mechanism to use.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
SHA |
|
MD5 message digest. |
- Default value
-
'SHA'
authentication-key
The authentication key.
Data Validation Constraint
Validation Error: |
The 'authentication-key' leaf is deprecated. Use 'authentication-key-id' instead. |
Type secret
- Description
-
A secret, which will be automatically encrypted using the secrets-private-key configured in the Site Definition File (SDF).
- Value
-
a string
- Default value
-
'internal-use-only'
authentication-key-id
A reference to authentication key stored in the secret store.
This node is mandatory.
Related Constraint
../authentication-key has a Data Validation Constraint which references this node. The validation expression refers to this node as ../authentication-key-id.
Type secret-freeform-id
- Description
-
A string that represents a secret identifier for a freeform secret such as a password. i.e. not a secret private key or certificate. This must reference a secret value stored securely in the secret store.
- Value
-
a string
privacy-protocol
The privacy mechanism to use.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Data Encryption Standard (DES) |
|
Triple Data Encryption Standard (3DES). |
|
128 bit Advanced Encryption Standard (AES). |
|
192 bit Advanced Encryption Standard (AES). |
|
256 bit Advanced Encryption Standard (AES). |
- Default value
-
'AES128'
privacy-key
The privacy key.
Data Validation Constraint
Validation Error: |
The 'privacy-key' leaf is deprecated. Use 'privacy-key-id' instead. |
Type secret
- Description
-
A secret, which will be automatically encrypted using the secrets-private-key configured in the Site Definition File (SDF).
- Value
-
a string
- Default value
-
'internal-use-only'
privacy-key-id
A reference to privacy key stored in the secret store.
This node is mandatory.
Related Constraint
../privacy-key has a Data Validation Constraint which references this node. The validation expression refers to this node as ../privacy-key-id.
Type secret-freeform-id
- Description
-
A string that represents a secret identifier for a freeform secret such as a password. i.e. not a secret private key or certificate. This must reference a secret value stored securely in the secret store.
- Value
-
a string
