REST API - hash
  1. Operations
  2. appliance
  3. techpreview
  4. monitoring
  5. snmp

appliance techpreview monitoring snmp: hash

Generate localized keys for secure SNMPv3 communications.

Request:

HTTP request

POST https://{server}/rest/appliance/techpreview/monitoring/snmp/hash

Request Body Structure:

{
    "config" : {
        "priv_hash" : "string",
        "auth_hash" : "string",
        "raw_secret" : true
    }
}

Request Body Parameters:

Name Type Description
bold = required
config SNMP_hash_config SNMP hash configuration.
config.auth_hash string Provide filename to secret for authentication hash, use in set --users (required secret)
config.priv_hash string Provide filename to secret for privacy hash, use in set --users (secret)
config.raw_secret boolean Make --auth_path and --priv_path flags read raw secret from command line instead of file.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "auth_key" : "string",
        "priv_key" : "string"
    }
}

Response Type:

Name Type Description
bold = required
value SNMP_hash_results SNMP hash result.
value.auth_key string SNMP authentication key
value.priv_key string SNMP privacy key

Errors:

HTTP Status Code Type Description
500 error Generic error