nxapi:Inst
NXAPI Instance
Telemetry Sensor Path(s)
Configurable Properties
| PROPERTY NAME | DATA TYPE | DESCRIPTION | PERMITTED VALUES |
|---|---|---|---|
| certEnable | scalar:Bool |
Certificate status of NX-API | SELECTION: true or false |
| certFile | os:OsString (naming:Name) |
Certificate file for NX-API | RANGE: [0 , 256] |
| clientCertAuth | nxapi:ClientCertAuthType (scalar:Enum8) |
Enable Mutual SSL Certificate Authentication for NXAPI between client and server and set verficiation restriction level | SELECTION: 0 - off 1 - optional 2 - strict 3 - two-step DEFAULT: off |
| encrKeyPassphrase | nxapi:keyPassphrase (string:Basic) |
Passphrase to decrypt the encrypted key file for NX-API | MAX SIZE: 1020 |
| httpPort | nxapi:HttpPort (scalar:Sint32) |
HTTP Port | RANGE: [-1 , 65535] DEFAULT: -1 |
| httpsPort | nxapi:HttpsPort (scalar:Sint32) |
HTTPS Port | RANGE: [-1 , 65535] DEFAULT: 443 |
| idleTimeout | scalar:Uint16 |
Specifies the idle timeout (in minutes) before a session expires. | RANGE: [1 , 1440] DEFAULT: 10 |
| keyFile | os:OsString (naming:Name) |
Key file for NX-API | RANGE: [0 , 256] |
| sslCiphersWeak | scalar:Bool |
Enable Weak Ciphers for SSL | SELECTION: true or false DEFAULT: 0 |
| sslProtocols | nxapi:SslProtocols (os:OsString) |
String of space separated SSL protocols to be supported | RANGE: [0 , 256] DEFAULT: TLSv1.2 |
| useVrf | os:OsString (naming:Name) |
Vrf for NX-API | RANGE: [0 , 256] |
Internal Properties
| PROPERTY NAME | DATA TYPE | DESCRIPTION | POSSIBLE VALUES |
|---|---|---|---|
| modTs | mo:TStamp (scalar:Date) |
The time when this object was last modified. | SELECTION: 0 - never DEFAULT: never |
| status | mo:ModificationStatus (scalar:Bitmask32) |
The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |