SSH (Secure Shell) is used to provide secure remote console access to NSGs deployed in branch locations. When key-based authentication is in use, the SSH keys represent the list of public keys that are authorized to open an SSH connection with the username set at the Access Profile level.
| description |
| embeddedMetadata |
| entityScope |
| externalID |
| keyType |
| lastUpdatedBy |
| name |
| publicKey |
This object has no members.
A description of the SSH Key.
Format: free
Max length: 255
SDK attribute: description
Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.
SDK attribute: embeddedMetadata
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
Type of SSH Key defined. Only RSA supported for now.
Allowed values: RSA
Default value: RSA
SDK attribute: keyType
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
Name of the SSH Key.
Format: free
Min length: 1
Max length: 255
SDK attribute: name
Public Key of a SSH Key Pair.
Format: free
Max length: 4096
SDK attribute: publicKey