| getdnskeyResult Structure Definition |
The getdnskeyResult structure defines the return type for getdnskey API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
dnskeyList |
List of dnskeys |
| dnskey Structure Definition |
The dnskey structure defines the actual return type values for getdnskey API. |
Syntax |
Members |
keyname |
Name of the public-private key pair. |
publickey |
File name of the public key. |
privatekey |
File name of the private key. |
expires |
Number of days since signing with this key, when the key expires. |
units |
Units for the expiry period. |
notificationperiod |
Time at which to generate notification of key expiration, specified as number of days, hours, or minutes before expiry. Must be less than the expiry period. The notification is an SNMP trap sent to an SNMP manager. To enable the appliance to send the trap, enable the DNSKEY-EXPIRY SNMP alarm.
In case autorollover option is enabled, rollover for successor key will be intiated at this time. No notification trap will be sent. |
units2 |
Units for the notification period. |
ttl |
Time to Live (TTL), in seconds, for the DNSKEY resource record created in the zone. TTL is the time for which the record must be cached by the DNS proxies. If the TTL is not specified, either the DNS zone's minimum TTL or the default value of 3600 is used. |
zonename |
Name of the zone for which the key is created. |
password |
Passphrase for reading the encrypted public/private DNS keys |
autorollover |
Flag to enable/disable key rollover automatically.
Note:
* Key name will be appended with _AR1 for successor key. For e.g. current key=k1, successor key=k1_AR1.
* Key name can be truncated if current name length is more than 58 bytes to accomodate the suffix. |
rollovermethod |
Method used for automatic rollover.
* Key type: ZSK, Method: PrePublication or DoubleSignature.
* Key type: KSK, Method: DoubleRRSet. |
state |
Current key state |
type |
Key type |
tag |
Key tag/ID |
createtimestr |
Key creation time |
activationtimestr |
Key activation time |
expirytimestr |
Key expiry time |
deletiontimestr |
Key deletion time if autorollover option is enabled |
rolloverfailrc |
Reason code in case rollover event failed |
revoke |
Revoke the key. Note: This operation is non-reversible. |
_nextgenapiresource |
See Also |